store/User

Source:

Methods

getCustomProperties() → {object}

Description:

  • Get custom properties.

Source:
Returns:
  • key value pairs of custom properties.
Type
object

getHomeContext() → {string}

Description:

  • Get the home context for this user.

Source:
Returns:
  • a context id (not the full resource URI).
Type
string

getLanguage() → {string}

Description:

  • Get the preferred language of the user.

Source:
Returns:
Type
string

getName() → {string}

Description:

  • Get the name of the user, this is a a unique name (username) in the current repository's _principals context.

Source:
Returns:
Type
string

getSource() → {Object}

Source:
Returns:
Type
Object

isDisabled() → {boolean}

Description:

  • Check if the user is disabled. Disabled users cannot sign in, although they still exist for lookup, e.g. when presenting creators and contributors.

Source:
Returns:
Type
boolean

(async) setCustomProperties(customProperties) → {Promise}

Description:

  • Set a new home context for this user.

Source:
Parameters:
Name Type Description
customProperties object
Returns:
Type
Promise

(async) setDisabled(disabled) → {Promise}

Description:

  • Set the user to be disabled or not.

Source:
Parameters:
Name Type Description
disabled boolean
Returns:
Type
Promise

(async) setHomeContext(contextId) → {Promise}

Description:

  • Set a new home context for this user.

Source:
Parameters:
Name Type Description
contextId string

a context id (not the full resource URI).
Returns:
Type
Promise

(async) setLanguage(language) → {Promise}

Description:

  • Sets the preferred language of a user.

Source:
Parameters:
Name Type Description
language string
Returns:
Type
Promise

(async) setName(name) → {Promise}

Description:

  • Set a new name (username), it will not succeed if it is already in use, for instance by another user or group.

Source:
Parameters:
Name Type Description
name string
Returns:
Type
Promise

(async) setPassword(newPassword, currentPassword) → {Promise}

Description:

  • Set a new password for the user.

Source:
Parameters:
Name Type Description
newPassword string

a new password, should be at least 8 characters long.
currentPassword string | undefined

the current password, may be required depending on EntryStore configuration.
Returns:
Type
Promise