Class ecm.model.User
Extends
ecm.model._ModelObject.
Represents a user of the repository. Private functions should not be used to access public members of the
class. Access member variables directly. For example:
var user = new User({ id: "user1", name: "user1", emailAddress: "user1@myplace.com" });
console.debug("Email address=" + user.emailAddress);
Defined in: <ecm\model\User.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
ecm.model.User(properties)
Constructor
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The user display name (may be null).
|
|
The email address of the user (if any).
|
|
A list of the privileges the user has within the repository.
|
|
An boolean that indicates if the user is a member of the owner role.
|
|
An array of ecm.model.Role objects this user is a member of.
|
|
The user short name (may be null).
|
- Fields borrowed from class ecm.model._ModelObject:
- categorization, id, isRecurring, name, nameFilter, pane, status, type, userId
Method Summary
Method Attributes | Method Name and Description |
---|---|
hasPrivilege(privilege)
Returns true if the user has the specified privilege and false if they do not.
|
|
toJSON()
Generates a JSON representation of this user.
|
|
<static> |
ecm.model.User.User.getCreatorOwnerPseudoUser()
Static function that creates a new creator/owner pseudo user object
|
Constructor Detail
ecm.model.User(properties)
Constructor
- Parameters:
- properties
- The properties for the model object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.
Field Detail
displayName
The user display name (may be null).
emailAddress
The email address of the user (if any).
maxPrivs
A list of the privileges the user has within the repository.
owner
An boolean that indicates if the user is a member of the owner role.
- Since:
- 2.0.3
roles
An array of ecm.model.Role objects this user is a member of.
shortName
The user short name (may be null).
Method Detail
hasPrivilege(privilege)
Returns true if the user has the specified privilege and false if they do not.
- Parameters:
- privilege
- The privilege to lookup.
toJSON()
Generates a JSON representation of this user.
<static> ecm.model.User.User.getCreatorOwnerPseudoUser()
Static function that creates a new creator/owner pseudo user object