Skip to content

Latest commit

 

History

History
174 lines (98 loc) · 3.81 KB

internal.api.md

File metadata and controls

174 lines (98 loc) · 3.81 KB

Public and Private API

API documentation automatically generated by docmeteor.

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

storeSchema: (schemaObject)  Anywhere

extends the user schema and updates the stored schema

Arguments

  • schemaObject {Object}

Returns Boolean true = schema updated false = schema not updated

storeSchema: function (type, label, key) { ... lib/utils.js:39

getGlobalKeys: ()  Anywhere

returns the current user schema - if changed it returns from database

Returns Object current User Schema

getGlobalKeys: function () { ... lib/utils.js:72

removeUserKey: ()  Anywhere

Changes the current user schema -> removes a key and updates the database

Returns Boolean true = updated schema false = key to remove does not exists

removeUserKey: function (key) { ... lib/utils.js:86

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

generatePassword()  Server

Generates a random password

Returns String

password with length 10

generatePassword = function () { ... server/methods.js:10

createUserWithoutPassword: (doc)  Server

creates a user without password

Arguments

  • doc {Object}

Returns Boolean

true = create user successfull

createUserWithoutPassword: function (doc) { ... server/methods.js:38

removeUser: (userId)  Server

removes a user

Arguments

  • userId {String}

Returns Boolean

true = remove user successfull

removeUser: function (userId) { ... server/methods.js:62

checkUsernameExisting: (username)  Server

checks if a given username already exists

Arguments

  • username {String}

Returns Boolean

true = username is existing false = username not existing

checkUsernameExisting: function (username) { ... server/methods.js:123

checkEmailExisting: (email)  Server

checks if a given email already exists

Arguments

  • email {String}

Returns Boolean

true = email is existing false = email not existing

checkEmailExisting: function (email) { ... server/methods.js:137

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

um.ROUTE_DEFAULT {any}  Anywhere

Routes configuration can be done by calling UserManagementTemplates.configureRoute with the route name and the
following options in a separate object. E.g. UserManagementTemplates.configureRoute("gingIn", option);
name:           String (optional). A unique route"s name to be passed to iron-router
path:           String (optional). A unique route"s path to be passed to iron-router
template:       String (optional). The name of the template to be rendered
layoutTemplate: String (optional). The name of the layout to be used

This property ROUTE_DEFAULT is defined in prototype of UM

UM.prototype.ROUTE_DEFAULT = { ... lib/core.js:24