Skip to content

Latest commit

 

History

History
234 lines (130 loc) · 4.55 KB

internal.api.md

File metadata and controls

234 lines (130 loc) · 4.55 KB

Public and Private API

API documentation automatically generated by docmeteor.

File: "lib/utils.js" Where: {client|server}

schemamanager.extendGroupSchemaExtern(schema)  Anywhere

extend the group schema

This method extendGroupSchemaExtern is defined in SchemaManager

Arguments

  • schema {Object}

SchemaManager.extendGroupSchemaExtern = function (schema) { ... lib/utils.js:5

File: "server/methods.js" Where: {server}

: (userId, groupId, roles)  Server

Add a user to a group

Arguments

  • userId {String}
  • groupId {String}
  • roles {Array}

Returns Boolean

true = user was added

: function (userId, groupId, roles) { ... server/methods.js:24

: (userId, email, groupId)  Server

removes a user from a group

Arguments

  • userId {String}
  • email {String}
  • groupId {String}

Returns Boolean

true = removed user from group successfull

: function (userId, email, groupId) { ... server/methods.js:66

checkGroupnameExisting: (groupname)  Server

checks if a given groupname already exists

Arguments

  • groupname {String}

Returns Boolean

true = groupname is existing false = groupname not existing

checkGroupnameExisting: function (groupname) { ... server/methods.js:111

createGroup: (doc, mod, documentId)  Server

creates a group (autoform method call)

Arguments

  • doc {Object}
  • mod {Object}
  • documentId {String}

Returns Boolean

true = created group successfull

createGroup: function (doc, mod, documentId) { ... server/methods.js:127

updateGroup: (doc, mod, documentId)  Server

updates a group (autoform method call)

Arguments

  • doc {Object}
  • mod {Object}
  • documentId {String}

Returns Boolean

true = edit group successfull

updateGroup: function (doc, mod, documentId) { ... server/methods.js:175

assignSubGroup: (groupId, parentGroupId)  Server

assigns a sub group to a group

Arguments

  • groupId {String}
  • parentGroupId {String}

Returns Boolean

true = assign subgroup successfull

assignSubGroup: function (groupId, parentGroupId) { ... server/methods.js:222

removeSubGroup: (groupId, parentGroupId)  Server

remove a sub group from a group

Arguments

  • groupId {String}
  • parentGroupId {String}

Returns Boolean

true = removed subgroup successfull

removeSubGroup: function (groupId, parentGroupId) { ... server/methods.js:245

removeGroup: (groupId)  Server

removes a group

Arguments

  • groupId {String}

Returns Boolean

true = removed group successfull

removeGroup: function (groupId) { ... server/methods.js:267

addUserRoleInGroup: function(groupId, userId, role)  Server

add user role

Arguments

  • groupId {String}
  • userId {String}
  • role {String}

Returns Boolean

true = added role

addUserRoleInGroup: function(groupId, userId, role){ ... server/methods.js:306

deleteUserRoleInGroup: function(groupId, userId, role)  Server

add user role

Arguments

  • groupId {String}
  • userId {String}
  • role {String}

Returns Boolean

true = added role

deleteUserRoleInGroup: function(groupId, userId, role){ ... server/methods.js:333