ParseClientConfiguration Class Reference

#import <ParseClientConfiguration.h>

Inheritance diagram for ParseClientConfiguration:

Instance Methods
(instancetype)	- NS_UNAVAILABLE

Class Methods
(instancetype)	+ configurationWithBlock:
	More...
(instancetype)	+ NS_UNAVAILABLE

Properties
NSString *	applicationId
	More...
NSString *	clientKey
NSString *	server
id< PFFileUploadController >	fileUploadController
BOOL	localDatastoreEnabled
	More...
NSString *	applicationGroupIdentifier
	More...
NSString *	containingApplicationBundleIdentifier
NSUInteger	networkRetryAttempts
	More...

Detailed Description

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:.

Method Documentation

+ (instancetype) configurationWithBlock:

(void(^)(id< ParseMutableClientConfiguration > configuration))

configurationBlock

---

---

Create a new SDK configuration object. This will create a temporarily modifiable configuration, and pass it to a block to be initialized.

Example usage:

``` [ParseClientConfiguration configurationWithBlock:^(id<ParseMutableClientConfiguration> configuration) { configuration.applicationId = ...; configuration.clientKey = ...; configuration.localDatastoreEnabled = ...; }]; ```

Parameters

configurationBlock

A block used to modify the created configuration.

Returns

A newly created configuration.

Property Documentation

- (NSString*) applicationGroupIdentifier

readnonatomiccopy

---

---

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.

- (NSString*) applicationId

readnonatomiccopy

---

---

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

- (NSString*) clientKey

readnonatomiccopy

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

- (NSString*) containingApplicationBundleIdentifier

readnonatomiccopy

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.

- (id<PFFileUploadController>) fileUploadController

readnonatomicstrong

The custom upload controller that synchronously uploads PFFiles using its own policy.

- (BOOL) localDatastoreEnabled

readnonatomicassign

---

---

Whether or not to enable pinning in the SDK.

The default value is NO.

- (NSUInteger) networkRetryAttempts

readnonatomicassign

---

---

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

- (NSString*) server

readnonatomiccopy

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

---

The documentation for this class was generated from the following file:

• Frameworks/Parse.framework/Headers/ParseClientConfiguration.h