Home Reference Source

Function

Static Public Summary
public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

The version of your app.
public

init(options: Object): Object

Initializes the SDK with your app's configuration.
public
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

setAppVersion(appVersion: string)

Set the version of your app.

Static Public

public APIVersionNotAvailableError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {APIVersionNotAvailableError} from './core/errors/apiVersionNotAvailable.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public APIVersionNotImplementedError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {APIVersionNotImplementedError} from './core/errors/apiVersionNotImplemented.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public ActiveUserError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {ActiveUserError} from './core/errors/activeUser.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public AppProblemError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {AppProblemError} from './core/errors/appProblem.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public BLError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {BLError} from './core/errors/bl.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public BadRequestError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {BadRequestError} from './core/errors/badRequest.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public BaseError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {BaseError} from './core/errors/base.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public CORSDisabledError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {CORSDisabledError} from './core/errors/corsDisabled.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public DuplicateEndUsersError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {DuplicateEndUsersError} from './core/errors/duplicateEndUsers.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public FeatureUnavailableError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {FeatureUnavailableError} from './core/errors/featureUnavailable.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public IncompleteRequestBodyError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {IncompleteRequestBodyError} from './core/errors/incompleteRequestBody.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public IndirectCollectionAccessDisallowedError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {IndirectCollectionAccessDisallowedError} from './core/errors/indirectCollectionAccessDisallowed.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public InsufficientCredentialsError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {InsufficientCredentialsError} from './core/errors/insufficientCredentials.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public InvalidCachedQuery(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {InvalidCachedQuery} from './core/errors/invalidCachedQuery.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public InvalidCredentialsError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {InvalidCredentialsError} from './core/errors/invalidCredentials.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public InvalidIdentifierError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {InvalidIdentifierError} from './core/errors/invalidIdentifier.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public InvalidQuerySyntaxError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {InvalidQuerySyntaxError} from './core/errors/invalidQuerySyntax.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public JSONParseError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {JSONParseError} from './core/errors/jsonParse.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public KinveyError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {KinveyError} from './core/errors/kinvey.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public KinveyInternalErrorRetry(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {KinveyInternalErrorRetry} from './core/errors/kinveyInternalErrorRetry.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public KinveyInternalErrorStop(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {KinveyInternalErrorStop} from './core/errors/kinveyInternalErrorStop.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public MissingConfigurationError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {MissingConfigurationError} from './core/errors/missingConfiguration.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public MissingQueryError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {MissingQueryError} from './core/errors/missingQuery.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public MissingRequestHeaderError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {MissingRequestHeaderError} from './core/errors/missingRequestHeader.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public MissingRequestParameterError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {MissingRequestParameterError} from './core/errors/missingRequestParameter.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public MobileIdentityConnectError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {MobileIdentityConnectError} from './core/errors/mobileIdentityConnect.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public NetworkConnectionError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {NetworkConnectionError} from './core/errors/networkConnection.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public NoActiveUserError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {NoActiveUserError} from './core/errors/noActiveUser.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public NoResponseError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {NoResponseError} from './core/errors/noResponse.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public NotFoundError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {NotFoundError} from './core/errors/notFound.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public ParameterValueOutOfRangeError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {ParameterValueOutOfRangeError} from './core/errors/parameterValueOutOfRange.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public PopupError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {PopupError} from './core/errors/popup.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public QueryError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {QueryError} from './core/errors/query.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public ResultSetSizeExceededError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {ResultSetSizeExceededError} from './core/errors/resultSetSizeExceeded.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public ServerError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {ServerError} from './core/errors/server.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public StaleRequestError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {StaleRequestError} from './core/errors/staleRequest.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public SyncError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {SyncError} from './core/errors/sync.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public TimeoutError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {TimeoutError} from './core/errors/timeout.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public UserAlreadyExistsError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {UserAlreadyExistsError} from './core/errors/userAlreadyExists.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public WritesToCollectionDisallowedError(message: *, debug: *, code: *, kinveyRequestId: *) source 

import {WritesToCollectionDisallowedError} from './core/errors/writesToCollectionDisallowed.js'

Params:

NameTypeAttributeDescription
message *
debug *
code *
kinveyRequestId *

public getAppVersion(): string source 

import {getAppVersion} from './core/kinvey.js'

The version of your app. It will sent with Network API requests using the X-Kinvey-Api-Version header.

Return:

string

The version of your app.

Example:

var appVersion = Kinvey.getAppVersion();

public init(options: Object): Object source 

import {init} from './core/kinvey.js'

Initializes the SDK with your app's configuration.

Params:

NameTypeAttributeDescription
options Object

Options
options.instanceId string
  • optional
  • default: ''

Custom subdomain for Kinvey API and MIC requests.
options.apiHostname string
  • optional
  • default: 'https://baas.kinvey.com'

Deprecated: Use options.instanceId instead.
options.micHostname string
  • optional
  • default: 'https://auth.kinvey.com'

Deprecated: Use options.instanceId instead.
options.appKey string
  • optional

App Key
options.appSecret string
  • optional

App Secret
options.appVersion string
  • optional

App Version

Return:

Object

Your app's configuration.

Throw:

KinveyError

If an options.appKey is not provided.

KinveyError

If an options.appSecret is not provided.

public initialize(options: Object): Promise source 

import {initialize} from './core/kinvey.js'
this function was deprecated. Please use init().

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

Params:

NameTypeAttributeDescription
options Object

Options
options.instanceId string
  • optional
  • default: ''

Custom subdomain for Kinvey API and MIC requests.
options.apiHostname string
  • optional
  • default: 'https://baas.kinvey.com'

Deprecated: Use options.instanceId instead.
options.micHostname string
  • optional
  • default: 'https://auth.kinvey.com'

Deprecated: Use options.instanceId instead.
options.appKey string
  • optional

App Key
options.appSecret string
  • optional

App Secret
options.appVersion string
  • optional

App Version

Return:

Promise

A promise.

Throw:

KinveyError

If an options.appKey is not provided.

KinveyError

If neither an options.appSecret or options.masterSecret is provided.

public ping(): Promise<Object> source 

import {ping} from './core/kinvey.js'

Pings the Kinvey API service. This can be used to check if you have configured the SDK correctly.

Return:

Promise<Object>

The response from the ping request.

Example:

var promise = Kinvey.ping()
 .then(function(response) {
    console.log('Kinvey Ping Success. Kinvey Service is alive, version: ' + response.version + ', response: ' + response.kinvey);
 })
 .catch(function(error) {
   console.log('Kinvey Ping Failed. Response: ' + error.description);
 });

public setAppVersion(appVersion: string) source 

import {setAppVersion} from './core/kinvey.js'

Set the version of your app. It will be sent with Network API requests using the X-Kinvey-Api-Version header.

Params:

NameTypeAttributeDescription
appVersion string

App version.

Example:

Kinvey.setAppVersion('1.0.0');
// or
Kinvey.setAppVersion('v1');