Parse

Parse

new Parse()

Contains all Parse API classes and functions.

Classes

ParseACL
Analytics
AnonymousUtils
Cloud
ParseCLP
ParseConfig
ParseError
EventuallyQueue
FacebookUtils
ParseFile
LiveQuery
LiveQueryClient
Subscription
LocalDatastore
ParseObject
ParsePolygon
Push
ParseQuery
ParseRelation
ParseRole
ParseSchema
ParseSession
ParseUser

Members

(static) allowCustomObjectId :boolean

Type:
  • boolean

(static) applicationId :string

Type:
  • string

(static) encryptedUser :string

Type:
  • string

(static) idempotency :boolean

Type:
  • boolean

(static) javaScriptKey :string

Type:
  • string

(static) liveQueryServerURL :string

Type:
  • string

(static) masterKey :string

Type:
  • string

(static) secret :string

Type:
  • string

(static) serverAuthToken :string

Type:
  • string

(static) serverAuthType :string

Type:
  • string

(static) serverURL :string

Type:
  • string

Methods

(static) dumpLocalDatastore() → {object}

Gets all contents from Local Datastore

await Parse.dumpLocalDatastore();
Returns:
Type:
object

(static) enableEncryptedUser()

Enable the current user encryption. This must be called before login any user.

(static) enableLocalDatastore(pollingopt, msopt)

Enable pinning in your application. This must be called after Parse.initialize in your application.

Parameters:
Name Type Attributes Description
polling <optional>

Allow pinging the server /health endpoint. Default true

ms <optional>

Milliseconds to ping the server. Default 2000ms

(static) getServerHealth() → {Promise}

Returns information regarding the current server's health

Returns:
Type:
Promise

(static) initialize(applicationId, javaScriptKeyopt, masterKeyopt)

Call this method first to set up your authentication tokens for Parse.

Parameters:
Name Type Attributes Description
applicationId string

Your Parse Application ID.

javaScriptKey string <optional>

Your Parse JavaScript Key (Not needed for parse-server)

masterKey string <optional>

Your Parse Master Key. (Node.js only!)

(static) isEncryptedUserEnabled() → {boolean}

Flag that indicates whether Encrypted User is enabled.

Returns:
Type:
boolean

(static) isLocalDatastoreEnabled() → {boolean}

Flag that indicates whether Local Datastore is enabled.

Returns:
Type:
boolean

(static) setAsyncStorage(storage)

Call this method to set your AsyncStorage engine Starting [email protected], the ParseSDK do not provide a React AsyncStorage as the ReactNative module is not provided at a stable path and changes over versions.

Parameters:
Name Type Description
storage AsyncStorage

a react native async storage.

(static) setLocalDatastoreController(controller)

Call this method to set your LocalDatastoreStorage engine If using React-Native use Parse.setAsyncStorage()

Parameters:
Name Type Description
controller LocalDatastoreController

a data storage.