ParseMutableClientConfiguration

Objective-C

@protocol ParseMutableClientConfiguration <NSObject>

Swift

protocol ParseMutableClientConfiguration : NSObjectProtocol

The ParseMutableClientConfiguration represents a ParseClientConfiguration object that can be mutated.

It is only usable during the execution of the block passed to ParseClientConfiguration.+configurationWithBlock:, during which time you should set your properties on it, similar to the following:

configuration.applicationId = @"<#YOUR APPLICATION ID#>"
configuration.clientKey = @"<#YOUR CLIENT KEY#>"
configuration.localDatastoreEnabled = true

Connecting to Parse

  • The Parse.com application id to configure the SDK with.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *applicationId;

    Swift

    var applicationId: String? { get set }

  • The Parse.com client key to configure the SDK with.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *clientKey;

    Swift

    var clientKey: String? { get set }

  • The URL of the server that is being used by the SDK. Defaults to https://api.parse.com/1.

    Note

    Setting this property to a non-valid URL or nil will throw an NSInvalidArgumentException.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull server;

    Swift

    var server: String { get set }

  • Sets a custom file upload controller that uploads PFFiles using its own policy.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) id<PFFileUploadController> fileUploadController;

Enabling Local Datastore

  • Whether or not to enable pinning in the SDK.

    The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isLocalDatastoreEnabled) BOOL localDatastoreEnabled;

    Swift

    var isLocalDatastoreEnabled: Bool { get set }

Enabling Extensions Data Sharing

  • When set, enables data sharing with an application group identifier.

    After enabling - Local Datastore, PFUser.+currentUser, PFInstallation.+currentInstallation and all eventually commands are going to be available to every application/extension in a group that have the same Parse applicationId.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *applicationGroupIdentifier;

    Swift

    var applicationGroupIdentifier: String? { get set }

  • When set, controls the bundle identifier of the parent bundle to connect to.

    Warning

    This property should only be set from inside an extension environment.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *containingApplicationBundleIdentifier;

    Swift

    var containingApplicationBundleIdentifier: String? { get set }

Network Properties

  • A custom NSURLSessionConfiguration configuration that will be used from the SDK.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSURLSessionConfiguration *_Nonnull URLSessionConfiguration;

    Swift

    var urlSessionConfiguration: URLSessionConfiguration { get set }

  • The maximum number of retry attempts to make upon a failed network request.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger networkRetryAttempts;

    Swift

    var networkRetryAttempts: UInt { get set }