Home Reference Source

References

summary
public

C Acl

The Acl class is used as a wrapper for reading and setting permissions on an entity level.

public
public

Executes a custom endpoint.

public

The FileStore class is used to find, save, update, remove, count and group files.

public

The Metadata class is used to as a wrapper for accessing the _kmd properties of an entity.

public

C Query

The Query class is used to query for a subset of entities using the Kinvey API.

public

The version of your app.

public

F init(options: Object): Object

Initializes the SDK with your app's configuration.

public

F initialize(options: Object): Promise

this function was deprecated. Please use init().

Initializes the SDK with your app's information. The SDK is initialized when the returned promise resolves.

public

Pings the Kinvey API service.

public

F setAppVersion(appVersion: string)

Set the version of your app.

datastore

summary
public

The DataStore class is used to find, create, update, remove, count and group entities in a collection.

public

errors

summary
public

F ActiveUserError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F APIVersionNotAvailableError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F APIVersionNotImplementedError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F AppProblemError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F BadRequestError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F BaseError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F BLError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F CORSDisabledError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F DuplicateEndUsersError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F FeatureUnavailableError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F IncompleteRequestBodyError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F IndirectCollectionAccessDisallowedError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F InsufficientCredentialsError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F InvalidCachedQuery(message: *, debug: *, code: *, kinveyRequestId: *)

public

F InvalidCredentialsError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F InvalidIdentifierError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F InvalidQuerySyntaxError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F JSONParseError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F KinveyError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F KinveyInternalErrorRetry(message: *, debug: *, code: *, kinveyRequestId: *)

public

F KinveyInternalErrorStop(message: *, debug: *, code: *, kinveyRequestId: *)

public

F MissingConfigurationError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F MissingQueryError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F MissingRequestHeaderError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F MissingRequestParameterError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F MobileIdentityConnectError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F NetworkConnectionError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F NoActiveUserError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F NoResponseError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F NotFoundError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F ParameterValueOutOfRangeError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F PopupError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F QueryError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F ResultSetSizeExceededError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F ServerError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F StaleRequestError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F SyncError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F TimeoutError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F UserAlreadyExistsError(message: *, debug: *, code: *, kinveyRequestId: *)

public

F WritesToCollectionDisallowedError(message: *, debug: *, code: *, kinveyRequestId: *)

identity

summary
public

V AuthorizationGrant: {"AuthorizationCodeLoginPage": string, "AuthorizationCodeAPI": string}

Enum for Mobile Identity Connect authorization grants.

user

summary
public

C User

The User class is used to represent a single user on the Kinvey platform.