ParseObject

Static methods

Creates a reference to a subclass of Parse.Object with the given id. This does not exist on Parse.Object, only on subclasses.

A shortcut for:

 var Foo = Parse.Object.extend("Foo");
 var pointerToFoo = new Foo();
 pointerToFoo.id = "myObjectId";

Destroy the given list of models on the server if it was already persisted.

Unlike saveAll, if an error occurs while deleting an individual model, this method will continue trying to delete the rest of the models if possible, except in the case of a fatal error like a connection error.

In particular, the Parse.Error object returned in the case of error may be one of two types:

• A Parse.Error.AGGREGATE_ERROR. This object's "errors" property is an array of other Parse.Error objects. Each error object in this array has an "object" property that references the object that could not be deleted (for instance, because that object could not be found).
• A non-aggregate Parse.Error. This indicates a serious error that caused the delete operation to be aborted partway through (for instance, a connection failure in the middle of the delete).

Parse.Object.destroyAll([object1, object2, ...])
.then((list) => {
// All the objects were deleted.
}, (error) => {
// An error occurred while deleting one or more of the objects.
// If this is an aggregate error, then we can inspect each error
// object individually to determine the reason why a particular
// object was not deleted.
if (error.code === Parse.Error.AGGREGATE_ERROR) {
for (var i = 0; i < error.errors.length; i++) {
console.log("Couldn't delete " + error.errors[i].object.id +
"due to " + error.errors[i].message);
}
} else {
console.log("Delete aborted because of " + error.message);
}
});

Disable single instance objects, where any local objects with the same Id share the same attributes, and stay synchronized with each other. When disabled, you can have two instances of the same object in memory without them sharing attributes.

Enable single instance objects, where any local objects with the same Id share the same attributes, and stay synchronized with each other. This is disabled by default in server environments, since it can lead to security issues.

Creates a new subclass of Parse.Object for the given Parse class name.

Every extension of a Parse class will inherit from the most recent previous extension of that class. When a Parse.Object is automatically created by parsing JSON, it will use the most recent extension of that class.

You should call either:

    var MyClass = Parse.Object.extend("MyClass", {
        Instance methods,
        initialize: function(attrs, options) {
            this.someInstanceProperty = [],
            Other instance properties
        }
    }, {
        Class properties
    });

    var MyClass = Parse.Object.extend({
        className: "MyClass",
        Instance methods,
        initialize: function(attrs, options) {
            this.someInstanceProperty = [],
            Other instance properties
        }
    }, {
        Class properties
    });

Fetches the given list of Parse.Object. If any error is encountered, stops and calls the error handler.

  Parse.Object.fetchAll([object1, object2, ...])
   .then((list) => {
     // All the objects were fetched.
   }, (error) => {
     // An error occurred while fetching one of the objects.
   });

Fetches the given list of Parse.Object if needed. If any error is encountered, stops and calls the error handler.

  Parse.Object.fetchAllIfNeeded([object1, ...])
   .then((list) => {
     // Objects were fetched and updated.
   }, (error) => {
     // An error occurred while fetching one of the objects.
   });

Fetches the given list of Parse.Object if needed. If any error is encountered, stops and calls the error handler.

Includes nested Parse.Objects for the provided key. You can use dot notation to specify which fields in the included object are also fetched.

If any error is encountered, stops and calls the error handler.

  Parse.Object.fetchAllIfNeededWithInclude([object1, object2, ...], [pointer1, pointer2, ...])
   .then((list) => {
     // All the objects were fetched.
   }, (error) => {
     // An error occurred while fetching one of the objects.
   });

Fetches the given list of Parse.Object.

Includes nested Parse.Objects for the provided key. You can use dot notation to specify which fields in the included object are also fetched.

If any error is encountered, stops and calls the error handler.

  Parse.Object.fetchAllWithInclude([object1, object2, ...], [pointer1, pointer2, ...])
   .then((list) => {
     // All the objects were fetched.
   }, (error) => {
     // An error occurred while fetching one of the objects.
   });

Creates a new instance of a Parse Object from a JSON representation.

Asynchronously stores the objects and every object they point to in the local datastore, recursively, using a default pin name: _default.

If those other objects have not been fetched from Parse, they will not be stored. However, if they have changed data, all the changes will be retained.

await Parse.Object.pinAll([...]);

To retrieve object: query.fromLocalDatastore() or query.fromPin()

Asynchronously stores the objects and every object they point to in the local datastore, recursively.

If those other objects have not been fetched from Parse, they will not be stored. However, if they have changed data, all the changes will be retained.

await Parse.Object.pinAllWithName(name, [obj1, obj2, ...]);

To retrieve object: query.fromLocalDatastore() or query.fromPinWithName(name)

Registers a subclass of Parse.Object with a specific class name. When objects of that class are retrieved from a query, they will be instantiated with this subclass. This is only necessary when using ES6 subclassing.

Saves the given list of Parse.Object. If any error is encountered, stops and calls the error handler.

Parse.Object.saveAll([object1, object2, ...])
.then((list) => {
// All the objects were saved.
}, (error) => {
// An error occurred while saving one of the objects.
});

Asynchronously removes the objects and every object they point to in the local datastore, recursively, using a default pin name: _default.

await Parse.Object.unPinAll([...]);

Asynchronously removes all objects in the local datastore using a default pin name: _default.

await Parse.Object.unPinAllObjects();

Asynchronously removes all objects with the specified pin name. Deletes the pin name also.

await Parse.Object.unPinAllObjectsWithName(name);

Asynchronously removes the objects and every object they point to in the local datastore, recursively.

await Parse.Object.unPinAllWithName(name, [obj1, obj2, ...]);

Unegisters a subclass of Parse.Object with a specific class name.

Returns a local or server Id used uniquely identify this object

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

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

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

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.

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.

Clears all attributes on a model

Creates a new model with identical attributes to this one.

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

Destroy this model on the server if it was already persisted.

Deletes this object from the server at some unspecified time in the future, even if Parse is currently inaccessible.

Use this when you may not have a solid network connection, and don't need to know when the delete completes. If there is some problem with the object such that it can't be deleted, the request will be silently discarded.

Delete instructions made with this method will be stored locally in an on-disk cache until they can be transmitted to Parse. They will be sent immediately if possible. Otherwise, they will be sent the next time a network connection is available. Delete requests will persist even after the app is closed, in which case they will be sent the next time the app is opened.

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.

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

Determines whether this ParseObject is equal to another ParseObject

Gets the HTML-escaped value of an attribute.

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)

Returns true if this object exists on the Server

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

Asynchronously loads data from the local datastore into this object.

await object.fetchFromLocalDatastore();

You can create an unfetched pointer with Parse.Object.createWithoutData() and then call fetchFromLocalDatastore() on it.

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.

Gets the value of an attribute.

Returns the ACL for this object.

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

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.

Public methods

Returns true if the object has been fetched.

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

Asynchronously returns if the object is pinned

const isPinned = await object.isPinned();

Checks if the model is currently in a valid state.

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

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.

Asynchronously stores the object and every object it points to in the local datastore, recursively, using a default pin name: _default.

If those other objects have not been fetched from Parse, they will not be stored. However, if they have changed data, all the changes will be retained.

await object.pin();

To retrieve object: query.fromLocalDatastore() or query.fromPin()

Asynchronously stores the objects and every object they point to in the local datastore, recursively.

If those other objects have not been fetched from Parse, they will not be stored. However, if they have changed data, all the changes will be retained.

await object.pinWithName(name);

To retrieve object: query.fromLocalDatastore() or query.fromPinWithName(name)

Gets a relation on the given class for the attribute.

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

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

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

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(attrs);

object.save(null, options);

object.save(attrs, options);

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.
});

Saves this object to the server at some unspecified time in the future, even if Parse is currently inaccessible.

Use this when you may not have a solid network connection, and don't need to know when the save completes. If there is some problem with the object such that it can't be saved, it will be silently discarded.

Objects saved with this method will be stored locally in an on-disk cache until they can be delivered to Parse. They will be sent immediately if possible. Otherwise, they will be sent the next time a network connection is available. Objects saved this way will persist even after the app is closed, in which case they will be sent the next time the app is opened.

Sets a hash of model attributes on the object.

You can call it with an object containing keys and values, with one key and value, or dot notation. 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);

game.set("player.score", 10);

Sets the ACL to be used for this object.

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

Gets a Pointer referencing this Object.

Gets a Pointer referencing this Object.

Asynchronously removes the object and every object it points to in the local datastore, recursively, using a default pin name: _default.

await object.unPin();

Asynchronously removes the object and every object it points to in the local datastore, recursively.

await object.unPinWithName(name);

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

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