PFObject

@interface PFObject : NSObject

The PFObject class is a local representation of data persisted to the Parse cloud. This is the main class that is used to interact with objects in your app.

  • Initializes a new empty PFObject instance with a class name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithClassName:(nonnull NSString *)newClassName;

    Parameters

    newClassName

    A class name can be any alphanumeric string that begins with a letter. It represents an object in your app, like a ‘User’ or a 'Document’.

    Return Value

    Returns the object that is instantiated with the given class name.

  • Creates a new PFObject with a class name.

    Declaration

    Objective-C

    + (nonnull instancetype)objectWithClassName:(nonnull NSString *)className;

    Parameters

    className

    A class name can be any alphanumeric string that begins with a letter. It represents an object in your app, like a ‘User’ or a 'Document’.

    Return Value

    Returns the object that is instantiated with the given class name.

  • Creates a new PFObject with a class name, initialized with data constructed from the specified set of objects and keys.

    Declaration

    Objective-C

    + (nonnull instancetype)
        objectWithClassName:(nonnull NSString *)className
                 dictionary:(nullable NSDictionary<NSString *, id> *)dictionary;

    Parameters

    className

    The object’s class.

    dictionary

    An NSDictionary of keys and objects to set on the new PFObject.

    Return Value

    A PFObject with the given class name and set with the given data.

  • Creates a reference to an existing PFObject for use in creating associations between PFObjects.

    Calling dataAvailable on this object will return NO until -fetchIfNeeded has been called. No network request will be made.

    Declaration

    Objective-C

    + (nonnull instancetype)
        objectWithoutDataWithClassName:(nonnull NSString *)className
                              objectId:(nullable NSString *)objectId;

    Parameters

    className

    The object’s class.

    objectId

    The object id for the referenced object.

    Return Value

    A PFObject instance without data.

  • The class name of the object.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSString *_Nonnull parseClassName;
  • The id of the object.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *objectId;
  • When the object was last updated.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSDate *updatedAt;
  • When the object was created.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSDate *createdAt;
  • ACL

    The ACL for this object.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) PFACL *ACL;
  • Returns an array of the keys contained in this object.

    This does not include createdAt, updatedAt, authData, or objectId. It does include things like username and ACL.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSArray<NSString *> *_Nonnull allKeys;
  • Returns the value associated with a given key.

    See

    -objectForKeyedSubscript:

    Declaration

    Objective-C

    - (nullable id)objectForKey:(nonnull NSString *)key;

    Parameters

    key

    The key for which to return the corresponding value.

  • Sets the object associated with a given key.

    See

    -setObject:forKeyedSubscript:

    Declaration

    Objective-C

    - (void)setObject:(nonnull id)object forKey:(nonnull NSString *)key;

    Parameters

    object

    The object for key. A strong reference to the object is maintained by PFObject. Raises an NSInvalidArgumentException if object is nil. If you need to represent a nil value - use NSNull.

    key

    The key for object. Raises an NSInvalidArgumentException if key is nil.

  • Unsets a key on the object.

    Declaration

    Objective-C

    - (void)removeObjectForKey:(nonnull NSString *)key;

    Parameters

    key

    The key.

  • Returns the value associated with a given key.

    This method enables usage of literal syntax on PFObject. E.g. NSString *value = object[@"key"];

    See

    -objectForKey:

    Declaration

    Objective-C

    - (nullable id)objectForKeyedSubscript:(nonnull NSString *)key;

    Parameters

    key

    The key for which to return the corresponding value.

  • Returns the value associated with a given key.

    This method enables usage of literal syntax on PFObject. E.g. object[@"key"] = @"value";

    See

    -setObject:forKey:

    Declaration

    Objective-C

    - (void)setObject:(nonnull id)object forKeyedSubscript:(nonnull NSString *)key;

    Parameters

    object

    The object for key. A strong reference to the object is maintained by PFObject. Raises an NSInvalidArgumentException if object is nil. If you need to represent a nil value - use NSNull.

    key

    The key for object. Raises an NSInvalidArgumentException if key is nil.

  • Returns the instance of PFRelation class associated with the given key.

    Declaration

    Objective-C

    - (nonnull PFRelation *)relationForKey:(nonnull NSString *)key;

    Parameters

    key

    The key that the relation is associated with.

  • Returns the instance of PFRelation class associated with the given key.

    @deprecated Please use PFObject.-relationForKey: instead.

    Declaration

    Objective-C

    - (nonnull PFRelation *)relationforKey:(nonnull NSString *)key;

    Parameters

    key

    The key that the relation is associated with.

  • Clears any changes to this object made since the last call to save and sets it back to the server state.

    Declaration

    Objective-C

    - (void)revert;
  • Clears any changes to this object’s key that were done after last successful save and sets it back to the server state.

    Declaration

    Objective-C

    - (void)revertObjectForKey:(nonnull NSString *)key;

    Parameters

    key

    The key to revert changes for.

  • Adds an object to the end of the array associated with a given key.

    Declaration

    Objective-C

    - (void)addObject:(nonnull id)object forKey:(nonnull NSString *)key;

    Parameters

    object

    The object to add.

    key

    The key.

  • Adds the objects contained in another array to the end of the array associated with a given key.

    Declaration

    Objective-C

    - (void)addObjectsFromArray:(nonnull NSArray *)objects
                         forKey:(nonnull NSString *)key;

    Parameters

    objects

    The array of objects to add.

    key

    The key.

  • Adds 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.

    Declaration

    Objective-C

    - (void)addUniqueObject:(nonnull id)object forKey:(nonnull NSString *)key;

    Parameters

    object

    The object to add.

    key

    The key.

  • Adds the objects contained in another array to the array associated with a given key, only adding elements which are not already present in the array.

    @dicsussion The position of the insert is not guaranteed.

    Declaration

    Objective-C

    - (void)addUniqueObjectsFromArray:(nonnull NSArray *)objects
                               forKey:(nonnull NSString *)key;

    Parameters

    objects

    The array of objects to add.

    key

    The key.

  • Removes all occurrences of an object from the array associated with a given key.

    Declaration

    Objective-C

    - (void)removeObject:(nonnull id)object forKey:(nonnull NSString *)key;

    Parameters

    object

    The object to remove.

    key

    The key.

  • Removes all occurrences of the objects contained in another array from the array associated with a given key.

    Declaration

    Objective-C

    - (void)removeObjectsInArray:(nonnull NSArray *)objects
                          forKey:(nonnull NSString *)key;

    Parameters

    objects

    The array of objects to remove.

    key

    The key.

  • Increments the given key by 1.

    Declaration

    Objective-C

    - (void)incrementKey:(nonnull NSString *)key;

    Parameters

    key

    The key.

  • Increments the given key by a number.

    Declaration

    Objective-C

    - (void)incrementKey:(nonnull NSString *)key
                byAmount:(nonnull NSNumber *)amount;

    Parameters

    key

    The key.

    amount

    The amount to increment.

  • Saves the PFObject asynchronously.

    Declaration

    Objective-C

    - (id)saveInBackground;

    Return Value

    The task that encapsulates the work being done.

  • Saves the PFObject asynchronously and executes the given callback block.

    Declaration

    Objective-C

    - (void)saveInBackgroundWithBlock:(nullable PFBooleanResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *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. If more than 10MB of data is waiting to be sent, subsequent calls to -saveEventually will cause old saves to be silently discarded until the connection can be re-established, and the queued objects can be saved.

    Declaration

    Objective-C

    - (id)saveEventually;

    Return Value

    The task that encapsulates the work being done.

  • 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. If the save completes successfully while the object is still in memory, then callback will be called.

    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. If more than 10MB of data is waiting to be sent, subsequent calls to -saveEventually: will cause old saves to be silently discarded until the connection can be re-established, and the queued objects can be saved.

    Declaration

    Objective-C

    - (void)saveEventually:(nullable PFBooleanResultBlock)callback;

    Parameters

    callback

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • Saves a collection of objects all at once asynchronously.

    Declaration

    Objective-C

    + (id)saveAllInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The array of objects to save.

    Return Value

    The task that encapsulates the work being done.

  • Saves a collection of objects all at once asynchronously and executes the block when done.

    Declaration

    Objective-C

    + (void)saveAllInBackground:(nullable NSArray<PFObject *> *)objects
                          block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The array of objects to save.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • Deletes a collection of objects all at once asynchronously. - parameter: objects The array of objects to delete. - returns: The task that encapsulates the work being done.

    Declaration

    Objective-C

    + (id)deleteAllInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The array of objects to delete.

    Return Value

    The task that encapsulates the work being done.

  • Deletes a collection of objects all at once asynchronously and executes the block when done.

    Declaration

    Objective-C

    + (void)deleteAllInBackground:(nullable NSArray<PFObject *> *)objects
                            block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The array of objects to delete.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • Gets whether the PFObject has been fetched.

    Declaration

    Objective-C

    @property (readonly, getter=isDataAvailable, assign, nonatomic)
        BOOL dataAvailable;

    Return Value

    YES if the PFObject is new or has been fetched or refreshed, otherwise NO.

  • Refreshes the PFObject with the current data from the server.

    @deprecated Please use -fetch instead.

    Declaration

    Objective-C

    - (nullable instancetype)refresh;
  • Synchronously refreshes the PFObject with the current data from the server and sets an error if it occurs.

    @deprecated Please use -fetch: instead.

    Declaration

    Objective-C

    - (nullable instancetype)refresh:(NSError *_Nullable *_Nullable)error;

    Parameters

    error

    Pointer to an NSError that will be set if necessary.

  • Asynchronously refreshes the PFObject and executes the given callback block.

    @deprecated Please use -fetchInBackgroundWithBlock: instead.

    Declaration

    Objective-C

    - (void)refreshInBackgroundWithBlock:(nullable PFObjectResultBlock)block;

    Parameters

    block

    The block to execute. The block should have the following argument signature: ^(PFObject *object, NSError *error)

  • Fetches the PFObject asynchronously and sets it as a result for the task.

    Declaration

    Objective-C

    - (id)fetchInBackground;

    Return Value

    The task that encapsulates the work being done.

  • Fetches the PFObject asynchronously and executes the given callback block.

    Declaration

    Objective-C

    - (void)fetchInBackgroundWithBlock:(nullable PFObjectResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(PFObject *object, NSError *error).

  • Fetches the PFObject data asynchronously if dataAvailable is NO, then sets it as a result for the task.

    Declaration

    Objective-C

    - (id)fetchIfNeededInBackground;

    Return Value

    The task that encapsulates the work being done.

  • Fetches the PFObject data asynchronously if dataAvailable is NO, then calls the callback block.

    Declaration

    Objective-C

    - (void)fetchIfNeededInBackgroundWithBlock:(nullable PFObjectResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(PFObject *object, NSError *error).

  • Fetches all of the PFObject objects with the current data from the server asynchronously.

    Declaration

    Objective-C

    + (id)fetchAllInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The list of objects to fetch.

    Return Value

    The task that encapsulates the work being done.

  • Fetches all of the PFObject objects with the current data from the server asynchronously and calls the given block.

    Declaration

    Objective-C

    + (void)fetchAllInBackground:(nullable NSArray<PFObject *> *)objects
                           block:(nullable PFArrayResultBlock)block;

    Parameters

    objects

    The list of objects to fetch.

    block

    The block to execute. It should have the following argument signature: ^(NSArray *objects, NSError *error).

  • Fetches all of the PFObject objects with the current data from the server asynchronously.

    Declaration

    Objective-C

    + (id)fetchAllIfNeededInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The list of objects to fetch.

    Return Value

    The task that encapsulates the work being done.

  • Fetches all of the PFObjects with the current data from the server asynchronously and calls the given block.

    Declaration

    Objective-C

    + (void)fetchAllIfNeededInBackground:(nullable NSArray<PFObject *> *)objects
                                   block:(nullable PFArrayResultBlock)block;

    Parameters

    objects

    The list of objects to fetch.

    block

    The block to execute. It should have the following argument signature: ^(NSArray *objects, NSError *error).

  • Asynchronously loads data from the local datastore into this object, if it has not been fetched from the server already.

    Declaration

    Objective-C

    - (id)fetchFromLocalDatastoreInBackground;

    Return Value

    The task that encapsulates the work being done.

  • Asynchronously loads data from the local datastore into this object, if it has not been fetched from the server already.

    Declaration

    Objective-C

    - (void)fetchFromLocalDatastoreInBackgroundWithBlock:
            (nullable PFObjectResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(PFObject *object, NSError *error).

  • Deletes the PFObject asynchronously.

    Declaration

    Objective-C

    - (id)deleteInBackground;

    Return Value

    The task that encapsulates the work being done.

  • Deletes the PFObject asynchronously and executes the given callback block.

    Declaration

    Objective-C

    - (void)deleteInBackgroundWithBlock:(nullable PFBooleanResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • 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. If more than 10MB of -saveEventually or -deleteEventually commands are waiting to be sent, subsequent calls to -saveEventually or -deleteEventually will cause old requests to be silently discarded until the connection can be re-established, and the queued requests can go through.

    Declaration

    Objective-C

    - (id)deleteEventually;

    Return Value

    The task that encapsulates the work being done.

  • Gets whether any key-value pair in this object (or its children) has been added/updated/removed and not saved yet.

    Declaration

    Objective-C

    @property (readonly, getter=isDirty, assign, nonatomic) BOOL dirty;

    Return Value

    Returns whether this object has been altered and not saved yet.

  • Get whether a value associated with a key has been added/updated/removed and not saved yet.

    Declaration

    Objective-C

    - (BOOL)isDirtyForKey:(nonnull NSString *)key;

    Parameters

    key

    The key to check for

    Return Value

    Returns whether this key has been altered and not saved yet.

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

    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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call -fetchFromLocalDatastore on it.

    Declaration

    Objective-C

    - (id)pinInBackground;

    Return Value

    The task that encapsulates the work being done.

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

    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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call -fetchFromLocalDatastore on it.

    Declaration

    Objective-C

    - (void)pinInBackgroundWithBlock:(nullable PFBooleanResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • Asynchronously stores the object and every object it points 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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call `-fetchFromLocalDatastore on it.

    See

    unpinInBackgroundWithName:

    Declaration

    Objective-C

    - (id)pinInBackgroundWithName:(nonnull NSString *)name;

    Parameters

    name

    The name of the pin.

    Return Value

    The task that encapsulates the work being done.

  • Asynchronously stores the object and every object it points 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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call -fetchFromLocalDatastore on it.

    See

    unpinInBackgroundWithName:block:

    Declaration

    Objective-C

    - (void)pinInBackgroundWithName:(nonnull NSString *)name
                              block:(nullable PFBooleanResultBlock)block;

    Parameters

    name

    The name of the pin.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call fetchFromLocalDatastore: on it.

    See

    unpinAllInBackground:

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (id)pinAllInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The objects to be pinned.

    Return Value

    The task that encapsulates the work being done.

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

    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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call fetchFromLocalDatastore: on it.

    See

    unpinAllInBackground:block:

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (void)pinAllInBackground:(nullable NSArray<PFObject *> *)objects
                         block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The objects to be pinned.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • 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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call fetchFromLocalDatastore: on it.

    See

    unpinAllInBackground:withName:

    Declaration

    Objective-C

    + (id)pinAllInBackground:(nullable NSArray<PFObject *> *)objects
                    withName:(nonnull NSString *)name;

    Parameters

    objects

    The objects to be pinned.

    name

    The name of the pin.

    Return Value

    The task that encapsulates the work being done.

  • 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. To get the objects back later, you can use a PFQuery that uses PFQuery.-fromLocalDatastore, or you can create an unfetched pointer with +objectWithoutDataWithClassName:objectId: and then call fetchFromLocalDatastore: on it.

    See

    unpinAllInBackground:withName:block:

    Declaration

    Objective-C

    + (void)pinAllInBackground:(nullable NSArray<PFObject *> *)objects
                      withName:(nonnull NSString *)name
                         block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The objects to be pinned.

    name

    The name of the pin.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    See

    pinInBackground

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    - (id)unpinInBackground;

    Return Value

    The task that encapsulates the work being done.

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

    See

    pinInBackgroundWithBlock:

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    - (void)unpinInBackgroundWithBlock:(nullable PFBooleanResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    See

    pinInBackgroundWithName:

    Declaration

    Objective-C

    - (id)unpinInBackgroundWithName:(nonnull NSString *)name;

    Parameters

    name

    The name of the pin.

    Return Value

    The task that encapsulates the work being done.

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

    See

    pinInBackgroundWithName:block:

    Declaration

    Objective-C

    - (void)unpinInBackgroundWithName:(nonnull NSString *)name
                                block:(nullable PFBooleanResultBlock)block;

    Parameters

    name

    The name of the pin.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (id)unpinAllObjectsInBackground;

    Return Value

    The task that encapsulates the work being done.

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

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (void)unpinAllObjectsInBackgroundWithBlock:
            (nullable PFBooleanResultBlock)block;

    Parameters

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

  • Asynchronously removes all objects with the specified pin name.

    Declaration

    Objective-C

    + (id)unpinAllObjectsInBackgroundWithName:(nonnull NSString *)name;

    Parameters

    name

    The name of the pin.

    Return Value

    The task that encapsulates the work being done.

  • Asynchronously removes all objects with the specified pin name.

    Declaration

    Objective-C

    + (void)unpinAllObjectsInBackgroundWithName:
                (nonnull NSString *)name block:(nullable PFBooleanResultBlock)block;

    Parameters

    name

    The name of the pin.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    See

    pinAllInBackground:

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (id)unpinAllInBackground:(nullable NSArray<PFObject *> *)objects;

    Parameters

    objects

    The objects.

    Return Value

    The task that encapsulates the work being done.

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

    See

    pinAllInBackground:block:

    See

    PFObjectDefaultPin

    Declaration

    Objective-C

    + (void)unpinAllInBackground:(nullable NSArray<PFObject *> *)objects
                           block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The objects.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

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

    See

    pinAllInBackground:withName:

    Declaration

    Objective-C

    + (id)unpinAllInBackground:(nullable NSArray<PFObject *> *)objects
                      withName:(nonnull NSString *)name;

    Parameters

    objects

    The objects.

    name

    The name of the pin.

    Return Value

    The task that encapsulates the work being done.

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

    See

    pinAllInBackground:withName:block:

    Declaration

    Objective-C

    + (void)unpinAllInBackground:(nullable NSArray<PFObject *> *)objects
                        withName:(nonnull NSString *)name
                           block:(nullable PFBooleanResultBlock)block;

    Parameters

    objects

    The objects.

    name

    The name of the pin.

    block

    The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).