On Get #

Called whenever an object is loaded from the server. Commonly used to hide properties, restrict access to private objects, and calculate dynamic values.

// Example On Get: Hide Secret Properties
if (!me || me.id !== this.creatorId) {
  hide('secret');
}

// Example On Get: Load A Post's Comments
if (query.loadComments) {
  dpd.comments.get({postId: this.id}, function(comments) {
    this.comments = comments;
  });  
}

Note: When a list of objects is loaded, On Get will run once for each object in the list. Calling cancel() in this case will remove the object from the list, rather than cancelling the entire request.

On Validate #

Called whenever an object's values change, including when it is first created. Commonly used to validate property values and calculate certain dynamic values (i.e. last modified time).

// Example On Validate: Enforce a max length
if (this.body.length > 100) {
  error('body', "Cannot be more than 100 characters");
}

// Example On Validate: Normalize an @handle
if (this.handle.indexOf('@') !== 0) {
  this.handle = '@' + this.handle;
}

Note: On Post or On Put will execute after On Validate, unless cancel() or error() is called

On Post #

Called when an object is created. Commonly used to prevent unauthorized creation and save data relevant to the creation of an object, such as its creator.

// Example On Post: Save the date created
this.createdDate = new Date().getTime();

// Example On Post: Prevent unauthorized users from posting
if (!me) {
  cancel("You must be logged in", 401);
}

On Put #

Called when an object is updated. Commonly used to restrict editing access to certain roles, or to protect certain properties from editing. It is strongly recommended that you protect() any properties that should not be modifiable by users after an object is created.

// Example On Put: Protect readonly/automatic properties
protect('createdDate');
protect('creatorId');

On Delete #

Called when an object is deleted. Commonly used to prevent unauthorized deletion.

// Example On Delete: Prevent non-admins from deleting
if (!me || me.role !== 'admin') {
  cancel("You must be an admin to delete this", 401);
}