Contains the metadata of this managed object
Optional
Readonly
createdDate of the creation of the object
createdAt
Entity.prototype
Optional
inactiveIndicates if the user is currently inactive, which disallow user login
Optional
Readonly
updatedLast update date of the object
updatedAt
Entity.prototype
Optional
usernameThe users username or email address
The unique id of this object
Sets the unique id of this object, if the id is not formatted as an valid id, it will be used as the key component of the id has the same affect as setting the key
The unique key part of the id When the key of the unique id is set an error will be thrown if an id is already set.
The version of this object
Attach this object to the given db
The db which will be used for future crud operations
Change the username of the current user
New username for the current user
The password of the current user
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Deletes an existing object
A Promise that will be fulfilled when the asynchronous operation completes.
Optional
options: { The remove options
Optional
depth?: number | booleanThe object depth which will be removed. Depth 0 removes this object only,
true
removes objects by reachability.
Optional
force?: booleanForce the remove operation, the version will not be validated.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Get all objects which refer to this object
A promise resolving with an array of all referencing objects
Optional
options: { Some options to pass
An array of class names to filter for, null for no filter
Inserts a new object. Inserts the object if it doesn't exists and raise an error if the object already exist.
A Promise that will be fulfilled when the asynchronous operation completes.
Optional
options: { The insertion options
Optional
depth?: number | booleanThe object depth which will be inserted. Depth 0 insert this object only,
true
inserts objects by reachability.
Optional
refresh?: booleanRefresh the local object state from remote.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Resolves the referenced object in the specified depth
Only unresolved objects will be loaded unless the refresh option is specified.
Removed objects will be marked as removed.
A Promise that will be fulfilled when the asynchronous operation completes.
Optional
options: { The load options
Optional
depth?: number | booleanThe object depth which will be loaded. Depth set to true
loads objects by reachability.
Optional
refresh?: booleanRefresh the local object state from remote.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Change the password of the given user
Current password of the user
New password of the user
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Saves the object and repeats the operation if the object is out of date
In each pass the callback will be called. Ths first parameter of the callback is the entity and the second one is a function to abort the process.
A Promise that will be fulfilled when the asynchronous operation completes.
Starts a partial update on this entity
Optional
operations: Jsoninitial operations which should be executed
Waits on the previously requested operation on this object completes operations on this object is completed.
A promise which completes successfully, when the previously requested operation completes
Waits on the previously requested operation on this object completes
A promise which completes successfully, when the previously requested operation completes
Requests a perpetual token for the user
Only users with the admin role are allowed to request an API token.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Saves the object. Inserts the object if it doesn't exists and updates the object if the object exist.
A Promise that will be fulfilled when the asynchronous operation completes.
Optional
options: { The save options
Optional
depth?: number | booleanThe object depth which will be saved. Depth 0 save this object only,
true
saves the objects by reachability.
Optional
force?: booleanForce the save operation, the version will not be validated.
Optional
refresh?: booleanRefresh the local object state from remote.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Converts the object to an JSON-Object
JSON-Object
Optional
options: boolean | { to json options by default excludes the metadata
Updates an existing object
Updates the object if it exists and raise an error if the object doesn't exist.
A Promise that will be fulfilled when the asynchronous operation completes.
Optional
options: { The update options
Optional
depth?: number | booleanThe object depth which will be updated. Depth 0 updates this object only,
true
updates objects by reachability.
Optional
force?: booleanForce the update operation, the version will not be validated, only existence will be checked.
Optional
refresh?: booleanRefresh the local object state from remote.
Optional
doneCallback: anyCalled when the operation succeed.
Optional
failCallback: anyCalled when the operation failed.
Validates the entity by using the validation code of the entity type
Contains the result of the Validation
Static
extendStatic
initInitialize the given instance
The managed instance to initialize
Optional
properties: { The optional properties to set on the instance
Generated using TypeDoc
The default constructor, copy all given properties to this object