Constructor
new Session(attributes)
Parameters:
Name | Type | Description |
---|---|---|
attributes |
Object
|
The initial set of data to store in the user. |
Extends
Members
createdAt :Date
The first time this object was saved on the server.
Properties:
Name | Type | Description |
---|---|---|
createdAt |
- Inherited From:
Type:
-
Date
updatedAt :Date
The last time this object was updated on the server.
Properties:
Name | Type | Description |
---|---|---|
updatedAt |
- Inherited From:
Type:
-
Date
Methods
(static) current() → {Promise}
Retrieves the Session object for the currently logged in session.
Returns:
- Type:
-
Promise
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.
(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:
_getStateIdentifier()
Returns a unique identifier used to pull data from the State Controller.
- Inherited From:
add(attr, item) → {ParseObject|Boolean}
Atomically add an object to the end of the array associated with a given key.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
item |
The item to add. |
Returns:
- Type:
-
ParseObject
|Boolean
addAll(attr, items)
Atomically add the objects to the end of the array associated with a given key.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
items |
Array.<Object>
|
The items to add. |
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
items |
Array.<Object>
|
The objects to add. |
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
item |
The object to add. |
clear() → {ParseObject|boolean}
Clears all attributes on a model
- Inherited From:
Returns:
- Type:
-
ParseObject
|boolean
clone() → {Parse.Object}
Creates a new model with identical attributes to this one.
- Inherited From:
Returns:
- Type:
-
Parse.Object
destroy(options) → {Promise}
Destroy this model on the server if it was already persisted.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is fulfilled when the destroy completes.
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
An attribute name (optional). |
Returns:
- Type:
-
Boolean
dirtyKeys() → {Array.<String>}
Returns an array of keys that have been modified since last save/refresh
- Inherited From:
Returns:
- Type:
-
Array.<String>
equals(other) → {Boolean}
Determines whether this ParseObject is equal to another ParseObject
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
other |
Object
|
An other object ot compare |
Returns:
- Type:
-
Boolean
escape(attr)
Gets the HTML-escaped value of an attribute.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The string name of an attribute. |
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:
Returns:
- Type:
-
Boolean
fetch(options) → {Promise}
Fetch the model from the server. If the server's representation of the model differs from its current attributes, they will be overriden.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is fulfilled when the fetch completes.
fetchWithInclude(keys, options) → {Promise}
Fetch the model from the server. If the server's representation of the model differs from its current attributes, they will be overriden.
Includes nested Parse.Objects for the provided key. You can use dot notation to specify which fields in the included object are also fetched.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
keys |
String
|
Array.<(string|Array.<string>)>
|
The name(s) of the key(s) to include. |
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is fulfilled when the fetch completes.
get(attr)
Gets the value of an attribute.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The string name of an attribute. |
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The string name of the attribute. |
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
amount |
Number
|
The amount to increment by (optional). |
isNew() → {Boolean}
Returns true if this object has never been saved to Parse.
- Inherited From:
Returns:
- Type:
-
Boolean
isValid() → {Boolean}
Checks if the model is currently in a valid state.
- Inherited From:
Returns:
- Type:
-
Boolean
newInstance() → {Parse.Object}
Creates a new instance of this object. Not to be confused with clone()
- Inherited From:
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.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
Returns:
- Type:
-
Parse.Op
The operation, or undefined if none.
relation(String) → {Parse.Relation}
Gets a relation on the given class for the attribute.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
String |
attr The attribute to get the relation for. |
Returns:
- Type:
-
Parse.Relation
remove(attr, item)
Atomically remove all instances of an object from the array associated with a given key.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
item |
The object to remove. |
removeAll(attr, items)
Atomically remove all instances of the objects from the array associated with a given key.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The key. |
items |
Array.<Object>
|
The object to remove. |
revert()
Clears any changes to this object made since the last call to save()
- Inherited From:
save(options) → {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();or
object.save(null, options);or
object.save(attrs, options);or
object.save(key, value, options);
For example,
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. });
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is fulfilled when the save completes.
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);
- Inherited From:
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 |
Returns:
- Type:
-
Boolean
true if the set succeeded.
setACL(acl, options) → {Boolean}
Sets the ACL to be used for this object.
- Inherited From:
- See:
Parameters:
Name | Type | Description |
---|---|---|
acl |
Parse.ACL
|
An instance of Parse.ACL. |
options |
Object
|
Returns:
- Type:
-
Boolean
Whether the set passed validation.
toJSON() → {Object}
Returns a JSON version of the object suitable for saving to Parse.
- Inherited From:
Returns:
- Type:
-
Object
toPointer() → {Pointer}
Gets a Pointer referencing this Object.
- Inherited From:
Returns:
- Type:
-
Pointer
unset(attr)
Remove an attribute from the model. This is a noop if the attribute doesn't exist.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
attr |
String
|
The string name of an attribute. |
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
- Inherited From:
- See:
Parameters:
Name | Type | Description |
---|---|---|
attrs |
Object
|
The current data to validate. |
Returns:
False if the data is valid. An error object otherwise.