JSDoc: Class: Session

Constructor

new Session(attributes)

Parameters:

Name	Type	Description
`attributes`	Object	The initial set of data to store in the user.

Extends

Parse.Object

Members

attributes

Prototype getters / setters

Inherited From:

Parse.Object#attributes

createdAt :Date

The first time this object was saved on the server.

Type:

Date

Properties:

Name	Type	Description
`createdAt`

Inherited From:

Parse.Object#createdAt

updatedAt :Date

The last time this object was updated on the server.

Type:

Date

Properties:

Name	Type	Description
`updatedAt`

Inherited From:

Parse.Object#updatedAt

Methods

(static) current() → {Parse.Promise}

Retrieves the Session object for the currently logged in session.

Returns:

A promise that is resolved with the Parse.Session object after it has been fetched. If there is no current user, the promise will be rejected.

Type: Parse.Promise

(static) isCurrentSessionRevocable() → {Boolean}

Determines whether the current session token is revocable. This method is useful for migrating Express.js or Node.js web apps to use revocable sessions. If you are migrating an app that uses the Parse SDK in the browser only, please use Parse.User.enableRevocableSession() instead, so that sessions can be automatically upgraded.

Returns:

Type: Boolean

_getId()

Returns a local or server Id used uniquely identify this object

Inherited From:

Parse.Object#_getId

_getStateIdentifier()

Returns a unique identifier used to pull data from the State Controller.

Inherited From:

Parse.Object#_getStateIdentifier

add(attr, item) → {ParseObject|Boolean}

Atomically add an object to the end of the array associated with a given key.

Parameters:

Name	Type	Description
`attr`	String	The key.
`item`		The item to add.

Inherited From:

Parse.Object#add

Returns:

Type: ParseObject | Boolean

addAll(attr, items)

Atomically add the objects to the end of the array associated with a given key.

Parameters:

Name	Type	Description
`attr`	String	The key.
`items`	Array.<Object>	The items to add.

Inherited From:

Parse.Object#addAll

addAllUnique(attr, items)

Atomically add the objects to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed.

Parameters:

Name	Type	Description
`attr`	String	The key.
`items`	Array.<Object>	The objects to add.

Inherited From:

Parse.Object#addAllUnique

addUnique(attr, item)

Atomically add an object to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed.

Parameters:

Name	Type	Description
`attr`	String	The key.
`item`		The object to add.

Inherited From:

Parse.Object#addUnique

clear() → {ParseObject|boolean}

Clears all attributes on a model

Inherited From:

Parse.Object#clear

Returns:

Type: ParseObject | boolean

clone() → {Parse.Object}

Creates a new model with identical attributes to this one, similar to Backbone.Model's clone()

Inherited From:

Parse.Object#clone

Returns:

Type: Parse.Object

destroy(options) → {Parse.Promise}

Destroy this model on the server if it was already persisted. If `wait: true` is passed, waits for the server to respond before removal.

Parameters:

Name	Type	Description
`options`	Object	A Backbone-style callback object. Valid options are: success: A Backbone-style success callback error: An Backbone-style error callback. useMasterKey: In Cloud Code and Node only, causes the Master Key to be used for this request. sessionToken: A valid session token, used for making a request on behalf of a specific user.

Inherited From:

Parse.Object#destroy

Returns:

A promise that is fulfilled when the destroy completes.

Type: Parse.Promise

dirty(attr) → {Boolean}

Returns true if this object has been modified since its last save/refresh. If an attribute is specified, it returns true only if that particular attribute has been modified since the last save/refresh.

Parameters:

Name	Type	Description
`attr`	String	An attribute name (optional).

Inherited From:

Parse.Object#dirty

Returns:

Type: Boolean

dirtyKeys() → {Array.<String>}

Returns an array of keys that have been modified since last save/refresh

Inherited From:

Parse.Object#dirtyKeys

Returns:

Type: Array.<String>

equals(other) → {Boolean}

Determines whether this ParseObject is equal to another ParseObject

Parameters:

Name	Type	Description
`other`	Object	An other object ot compare

Inherited From:

Parse.Object#equals

Returns:

Type: Boolean

escape(attr)

Gets the HTML-escaped value of an attribute.

Parameters:

Name	Type	Description
`attr`	String	The string name of an attribute.

Inherited From:

Parse.Object#escape

existed() → {Boolean}

Returns true if this object was created by the Parse server when the object might have already been there (e.g. in the case of a Facebook login)

Inherited From:

Parse.Object#existed

Returns:

Type: Boolean

fetch(options) → {Parse.Promise}

Fetch the model from the server. If the server's representation of the model differs from its current attributes, they will be overriden.

Parameters:

Name	Type	Description
`options`	Object	A Backbone-style callback object. Valid options are: success: A Backbone-style success callback. error: An Backbone-style error callback. useMasterKey: In Cloud Code and Node only, causes the Master Key to be used for this request. sessionToken: A valid session token, used for making a request on behalf of a specific user.

Inherited From:

Parse.Object#fetch

Returns:

A promise that is fulfilled when the fetch completes.

Type: Parse.Promise

get(attr)

Gets the value of an attribute.

Parameters:

Name	Type	Description
`attr`	String	The string name of an attribute.

Inherited From:

Parse.Object#get

getACL() → {Parse.ACL}

Returns the ACL for this object.

Inherited From:

Parse.Object#getACL

See:

Parse.Object#get

Returns:

An instance of Parse.ACL.

Type: Parse.ACL

getSessionToken() → {String}

Returns the session token string.

Returns:

Type: String

has(attr) → {Boolean}

Returns true if the attribute contains a value that is not null or undefined.

Parameters:

Name	Type	Description
`attr`	String	The string name of the attribute.

Inherited From:

Parse.Object#has

Returns:

Type: Boolean

increment(attr, amount)

Atomically increments the value of the given attribute the next time the object is saved. If no amount is specified, 1 is used by default.

Parameters:

Name	Type	Description
`attr`	String	The key.
`amount`	Number	The amount to increment by (optional).

Inherited From:

Parse.Object#increment

initialize()

Public methods

Inherited From:

Parse.Object#initialize

isNew() → {Boolean}

Returns true if this object has never been saved to Parse.

Inherited From:

Parse.Object#isNew

Returns:

Type: Boolean

isValid() → {Boolean}

Checks if the model is currently in a valid state.

Inherited From:

Parse.Object#isValid

Returns:

Type: Boolean

newInstance() → {Parse.Object}

Creates a new instance of this object. Not to be confused with clone()

Inherited From:

Parse.Object#newInstance

Returns:

Type: Parse.Object

op(attr) → {Parse.Op}

Returns an instance of a subclass of Parse.Op describing what kind of modification has been performed on this field since the last time it was saved. For example, after calling object.increment("x"), calling object.op("x") would return an instance of Parse.Op.Increment.

Parameters:

Name	Type	Description
`attr`	String	The key.

Inherited From:

Parse.Object#op

Returns:

The operation, or undefined if none.

Type: Parse.Op

relation(String) → {Parse.Relation}

Gets a relation on the given class for the attribute.

Parameters:

Name	Type	Description
`String`		attr The attribute to get the relation for.

Inherited From:

Parse.Object#relation

Returns:

Type: Parse.Relation

remove(attr, item)

Atomically remove all instances of an object from the array associated with a given key.

Parameters:

Name	Type	Description
`attr`	String	The key.
`item`		The object to remove.

Inherited From:

Parse.Object#remove

removeAll(attr, items)

Atomically remove all instances of the objects from the array associated with a given key.

Parameters:

Name	Type	Description
`attr`	String	The key.
`items`	Array.<Object>	The object to remove.

Inherited From:

Parse.Object#removeAll

revert()

Clears any changes to this object made since the last call to save()

Inherited From:

Parse.Object#revert

save(options) → {Parse.Promise}

Set a hash of model attributes, and save the model to the server. updatedAt will be updated when the request returns. You can either call it as:

  object.save();

  object.save(null, options);

  object.save(attrs, options);

  object.save(key, value, options);

For example,

  gameTurn.save({
    player: "Jake Cutter",
    diceRoll: 2
  }, {
    success: function(gameTurnAgain) {
      // The save was successful.
    },
    error: function(gameTurnAgain, error) {
      // The save failed.  Error is an instance of Parse.Error.
    }
  });

or with promises:

  gameTurn.save({
    player: "Jake Cutter",
    diceRoll: 2
  }).then(function(gameTurnAgain) {
    // The save was successful.
  }, function(error) {
    // The save failed.  Error is an instance of Parse.Error.
  });

Parameters:

Name	Type	Description
`options`	Object	A Backbone-style callback object. Valid options are: success: A Backbone-style success callback. error: An Backbone-style error callback. useMasterKey: In Cloud Code and Node only, causes the Master Key to be used for this request. sessionToken: A valid session token, used for making a request on behalf of a specific user.

Inherited From:

Parse.Object#save

Returns:

A promise that is fulfilled when the save completes.

Type: Parse.Promise

set(key, value, options) → {Boolean}

Sets a hash of model attributes on the object.

You can call it with an object containing keys and values, or with one key and value. For example:

  gameTurn.set({
    player: player1,
    diceRoll: 2
  }, {
    error: function(gameTurnAgain, error) {
      // The set failed validation.
    }
  });

  game.set("currentPlayer", player2, {
    error: function(gameTurnAgain, error) {
      // The set failed validation.
    }
  });

  game.set("finished", true);

Parameters:

Name	Type	Description
`key`	String	The key to set.
`value`		The value to give it.
`options`	Object	A set of options for the set. The only supported option is `error`.

Inherited From:

Parse.Object#set

Returns:

true if the set succeeded.

Type: Boolean

setACL(acl, options) → {Boolean}

Sets the ACL to be used for this object.

Parameters:

Name	Type	Description
`acl`	Parse.ACL	An instance of Parse.ACL.
`options`	Object	Optional Backbone-like options object to be passed in to set.

Inherited From:

Parse.Object#setACL

See:

Parse.Object#set

Returns:

Whether the set passed validation.

Type: Boolean

toJSON() → {Object}

Returns a JSON version of the object suitable for saving to Parse.

Inherited From:

Parse.Object#toJSON

Returns:

Type: Object

toPointer() → {Pointer}

Gets a Pointer referencing this Object.

Inherited From:

Parse.Object#toPointer

Returns:

Type: Pointer

unset(attr)

Remove an attribute from the model. This is a noop if the attribute doesn't exist.

Parameters:

Name	Type	Description
`attr`	String	The string name of an attribute.

Inherited From:

Parse.Object#unset

validate(attrs)

You should not call this function directly unless you subclass Parse.Object, in which case you can override this method to provide additional validation on set and save. Your implementation should return

Parameters:

Name	Type	Description
`attrs`	Object	The current data to validate.

Inherited From:

Parse.Object#validate

See:

Parse.Object#set

Returns:

False if the data is valid. An error object otherwise.