Classes

The following classes are available globally.

  • The PFACL class is used to control which users can access or modify a particular object. Each PFObject can have its own PFACL. You can grant read and write permissions separately to specific users, to groups of users that belong to roles, or you can grant permissions to the public so that, for example, any user could read a particular object but only a particular set of users could write to that object.

    See more

    Declaration

    Objective-C

    @interface PFACL : NSObject <NSCopying, NSCoding>

    Swift

    class PFACL : NSObject, NSCopying, NSCoding
  • PFAnalytics provides an interface to Parse’s logging and analytics backend.

    Methods will return immediately and cache the request (+ timestamp) to be handled eventually. That is, the request will be sent immediately if possible or the next time a network connection is available.

    See more

    Declaration

    Objective-C

    @interface PFAnalytics : NSObject

    Swift

    class PFAnalytics : NSObject
  • Provides utility functions for working with Anonymously logged-in users. Anonymous users have some unique characteristics:

    • Anonymous users don’t need a user name or password.
    • Once logged out, an anonymous user cannot be recovered.
    • When the current user is anonymous, the following methods can be used to switch to a different user or convert the anonymous user into a regular one:
    • signUp converts an anonymous user to a standard user with the given username and password. Data associated with the anonymous user is retained.
    • logIn switches users without converting the anonymous user. Data associated with the anonymous user will be lost.
    • Service logIn (e.g. Facebook, Twitter) will attempt to convert the anonymous user into a standard user by linking it to the service. If a user already exists that is linked to the service, it will instead switch to the existing user.
    • Service linking (e.g. Facebook, Twitter) will convert the anonymous user into a standard user by linking it to the service.
    See more

    Declaration

    Objective-C

    @interface PFAnonymousUtils : NSObject

    Swift

    class PFAnonymousUtils : NSObject
  • The PFCloud class provides methods for interacting with Parse Cloud Functions.

    See more

    Declaration

    Objective-C

    @interface PFCloud : NSObject

    Swift

    class PFCloud : NSObject
  • PFConfig is a representation of the remote configuration object. It enables you to add things like feature gating, a/b testing or simple Message of the day.

    See more

    Declaration

    Objective-C

    @interface PFConfig : NSObject

    Swift

    class PFConfig : NSObject
  • Extends the normal JSON to PFObject decoding to also deal with placeholders for new objects that have been saved offline.

    Declaration

    Objective-C

    @interface PFOfflineDecoder : PFDecoder

    Swift

    class PFOfflineDecoder : PFDecoder
  • A subclass of PFDecoder which can keep PFObject that has been fetched instead of creating a new instance.

    Declaration

    Objective-C

    @interface PFKnownParseObjectDecoder : PFDecoder

    Swift

    class PFKnownParseObjectDecoder : PFDecoder

  • Declaration

    Objective-C

    @interface PFEncoder : NSObject

    Swift

    class PFEncoder : NSObject
  • Encoding strategy that rejects PFObject.

    Declaration

    Objective-C

    @interface PFNoObjectEncoder : PFEncoder

    Swift

    class PFNoObjectEncoder : PFEncoder
  • Encoding strategy that encodes PFObject to PFPointer with objectId or with localId.

    Declaration

    Objective-C

    @interface PFPointerOrLocalIdObjectEncoder : PFEncoder

    Swift

    class PFPointerOrLocalIdObjectEncoder : PFEncoder
  • Encoding strategy that encodes PFObject to PFPointer with objectId and rejects unsaved PFObject.

    Declaration

    Objective-C

    @interface PFPointerObjectEncoder : PFPointerOrLocalIdObjectEncoder

    Swift

    class PFPointerObjectEncoder : PFPointerOrLocalIdObjectEncoder
  • Encoding strategy that can encode objects that are available offline. After using this encoder, you must call encodeFinished and wait for its result to be finished before the results of the encoding will be valid.

    Declaration

    Objective-C

    @interface PFOfflineObjectEncoder : PFEncoder

    Swift

    class PFOfflineObjectEncoder : PFEncoder
  • PFFile representes a file of binary data stored on the Parse servers. This can be a image, video, or anything else that an application needs to reference in a non-relational way.

    See more

    Declaration

    Objective-C

    @interface PFFile : NSObject

    Swift

    class PFFile : NSObject
  • PFGeoPoint may be used to embed a latitude / longitude point as the value for a key in a PFObject. It could be used to perform queries in a geospatial manner using PFQuery.-whereKey:nearGeoPoint:.

    Currently, instances of PFObject may only have one key associated with a PFGeoPoint type.

    See more

    Declaration

    Objective-C

    @interface PFGeoPoint : NSObject <NSCopying, NSCoding>

    Swift

    class PFGeoPoint : NSObject, NSCopying, NSCoding
  • A Parse Framework Installation Object that is a local representation of an installation persisted to the Parse cloud. This class is a subclass of a PFObject, and retains the same functionality of a PFObject, but also extends it with installation-specific fields and related immutability and validity checks.

    A valid PFInstallation can only be instantiated via +currentInstallation because the required identifier fields are readonly. The timeZone and badge fields are also readonly properties which are automatically updated to match the device’s time zone and application badge when the PFInstallation is saved, thus these fields might not reflect the latest device state if the installation has not recently been saved.

    PFInstallation objects which have a valid deviceToken and are saved to the Parse cloud can be used to target push notifications.

    See more

    Declaration

    Objective-C

    
    @interface PFInstallation : PFObject <PFSubclassing>

    Swift

    class PFInstallation : PFObject, PFSubclassing
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface PFObject : NSObject

    Swift

    class PFObject : NSObject
  • PFPolygon may be used to embed a latitude / longitude points as the value for a key in a PFObject. It could be used to perform queries in a geospatial manner using PFQuery.-whereKey:polygonContains:.

    See more

    Declaration

    Objective-C

    @interface PFPolygon : NSObject <NSCopying, NSCoding>

    Swift

    class PFPolygon : NSObject, NSCopying, NSCoding
  • The PFPush class defines a push notification that can be sent from a client device.

    The preferred way of modifying or retrieving channel subscriptions is to use the PFInstallation class, instead of the class methods in PFPush.

    See more

    Declaration

    Objective-C

    
    @interface PFPush : NSObject <NSCopying>

    Swift

    class PFPush : NSObject, NSCopying
  • The PFQuery class defines a query that is used to query for PFObjects.

    See more

    Declaration

    Objective-C

    @interface PFQuery <PFGenericObject : PFObject *> : NSObject<NSCopying> 

    Swift

    class PFQuery
  • The PFRelation class that is used to access all of the children of a many-to-many relationship. Each instance of PFRelation is associated with a particular parent object and key.

    See more

    Declaration

    Objective-C

    @interface PFRelation <ObjectType : PFObject *> : NSObject

    Swift

    class PFRelation
  • The PFRole class represents a Role on the Parse server. PFRoles represent groupings of PFUser objects for the purposes of granting permissions (e.g. specifying a PFACL for a PFObject). Roles are specified by their sets of child users and child roles, all of which are granted any permissions that the parent role has.

    Roles must have a name (which cannot be changed after creation of the role), and must specify an ACL.

    See more

    Declaration

    Objective-C

    @interface PFRole : PFObject <PFSubclassing>

    Swift

    class PFRole : PFObject, PFSubclassing
  • The PFUser class is a local representation of a user persisted to the Parse Data. This class is a subclass of a PFObject, and retains the same functionality of a PFObject, but also extends it with various user specific methods, like authentication, signing up, and validation uniqueness.

    Many APIs responsible for linking a PFUser with Facebook or Twitter have been deprecated in favor of dedicated utilities for each social network. See PFFacebookUtils, PFTwitterUtils and PFAnonymousUtils for more information.

    See more

    Declaration

    Objective-C

    @interface PFUser : PFObject <PFSubclassing>

    Swift

    class PFUser : PFObject, PFSubclassing
  • The Parse class contains static functions that handle global configuration for the Parse framework.

    See more

    Declaration

    Objective-C

    @interface Parse : NSObject

    Swift

    class Parse : NSObject
  • The ParseClientConfiguration represents the local configuration of the SDK to connect to the server with.

    These configurations can be stored, copied, and compared, but cannot be safely changed once the SDK is initialized.

    Use this object to construct a configuration for the SDK in your application, and pass it to Parse.+initializeWithConfiguration:.

    See more

    Declaration

    Objective-C

    @interface ParseClientConfiguration : NSObject <NSCopying>

    Swift

    class ParseClientConfiguration : NSObject, NSCopying