SDK

SDK Javascript v7.x

2

Kuzzle v2

Kuzzle v1
Kuzzle v2

/core/2/guides/

Kuzzle v2

Kuzzle v1
Kuzzle v2

/core/2/guides/

Javascript v7.x

API v2.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x

Getting Started

Browser (Vanilla)

Essentials

Realtime notifications

Extends the SDK

Realtime Application

Batch Processing

Core Classes

> BaseController

> Kuzzle

> KuzzleError

> KuzzleEventEmitter

addOnceListener

prependListener

prependOnceListener

removeAllListeners

> Profile

> Role

> SearchResult

> User

> BatchController

> Observer

Protocols

> Http

> WebSocket

Controllers

> auth

createMyCredentials

credentialsExist

deleteMyCredentials

getMyCredentials

updateMyCredentials

validateMyCredentials

> bulk

> collection

deleteSpecifications

getSpecifications

searchSpecifications

updateSpecifications

validateSpecifications

> document

createOrReplace

mCreateOrReplace

> index

> ms

georadiusbymember

zremrangebyrank

zremrangebyscore

zrevrangebyscore

> realtime

> security

createCredentials

createFirstAdmin

createOrReplaceProfile

createOrReplaceRole

createRestrictedUser

deleteCredentials

getAllCredentialFields

getCredentialFields

getCredentialsById

getProfileMapping

getProfileRights

getUserStrategies

mDeleteProfiles

updateCredentials

updateProfileMapping

updateRoleMapping

updateUserMapping

validateCredentials

> server

Javascript v7.x

API v2.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x

KuzzleError #

Inherits from the standard Error class.

The KuzzleError class represents an error response from Kuzzle API.