Kuzzle Backend v2
Kuzzle IoT v3
Customer access
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Drivers
Search
Ctrl K
Discover Kuzzle
Kuzzle Backend v2
Kuzzle IoT v3
Customer access
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Drivers
Classes
Backend
Constructor
Properties
install
start
trigger
BackendCluster
Properties
broadcast
off
on
once
removeAllListeners
BackendConfig
Properties
merge
set
BackendController
Properties
register
use
BackendErrors
Properties
get
getFrom
register
wrap
BackendHook
Properties
register
BackendImport
Properties
mappings
profiles
roles
userMappings
users
BackendOpenApi
Properties
BackendPipe
Properties
register
unregister
BackendPlugin
Properties
get
list
use
BackendStorage
Properties
getEngine
BackendSubscription
Properties
add
remove
BackendVault
Properties
DataValidation
Properties
addType
validate
EmbeddedSDK
Properties
as
query
HttpStream
Properties
constructor
destroy
Inflector
camelCase
kebabCase
pascalCase
snakeCase
upFirst
InternalLogger
Properties
debug
fatal
info
level
trace
use
verbose
warn
Koncorde
Properties
constructor
convertDistance
convertGeopoint
exists
getCollections
getFilterIds
getIndexes
hasFilter
normalize
register
remove
store
test
validate
KuzzleRequest
Constructor
Properties
addDeprecation
clearError
getAction
getArray
getArrayFromBodyOrArgs
getArrayLegacy
getArrayOrCsv
getBody
getBodyArray
getBodyBoolean
getBodyInteger
getBodyNumber
getBodyObject
getBodyString
getBoolean
getCollection
getController
getDate
getId
getIndex
getIndexAndCollection
getInteger
getKuid
getLangParam
getNumber
getObject
getObjectFromBodyOrArgs
getRefresh
getScrollTTLParam
getSearchBody
getSearchParams
getString
getTimestamp
getUser
pojo
serialize
setError
setResult
userIsAdmin
Logger
Properties
child
debug
error
fatal
flush
getLevel
info
setLevel
silly
trace
verbose
warn
Mutex
Constructor
Properties
lock
unlock
wait
NameGenerator
generateRandomName
getRandomAdjective
getRandomName
PluginContext
Properties
PluginContextAccessors
Properties
execute
getStorageEngine
trigger
PluginContextConstructors
Properties
PluginStorage
Properties
bootstrap
createCollection
PluginStrategy
Properties
add
remove
Repository
Properties
contructor
create
createOrReplace
delete
get
mGet
replace
search
update
RequestContext
Properties
RequestInput
Properties
RequestResponse
Properties
configure
getHeader
removeHeader
setHeader
setHeaders
toJSON
Subscription
Properties
register
unregister
Functions
withLock
Abstract Classes
BaseValidationType
Properties
checkAllowedProperties
getStrictness
validate
validateFieldSpecification
Controller
Properties
constructor
KuzzleError
Constructor
Properties
toJSON
Plugin
Properties
constructor
init
Error Classes
BadRequestError
Constructor
Properties
ExternalServiceError
Constructor
Properties
ForbiddenError
Constructor
Properties
GatewayTimeoutError
Constructor
Properties
InternalError
Constructor
Properties
MultipleErrorsError
Constructor
Properties
MutexAcquireError
Constructor
Properties
MutexLockLostError
Constructor
Properties
NotFoundError
Constructor
Properties
PartialError
Constructor
Properties
PluginImplementationError
Constructor
Properties
PreconditionError
Constructor
Properties
ServiceUnavailableError
Constructor
Properties
SizeLimitError
Constructor
Properties
TooManyRequestsError
Constructor
Properties
UnauthorizedError
Constructor
Properties
Types
API contract types
ControllerDefinition
ControllerRights
CustomErrorDefinition
DefaultMappings
Deprecation
EventHandler
HttpRoute
ImportConfig
InstallationConfig
JSONObject
KDocument
KuzzleConfiguration
KuzzleToken
KuzzleUser
MutexConfig
OpenApiDefinition
PluginManifest
RequestPayload
ResponsePayload
StartOptions
StrategyDefinition
SupportConfig
Events
API
Auth
Connection
Core
Generic Document
HTTP
Hook
Kuzzle
Plugin
Realtime
Request
Websocket
Wildcard
Services
Framework
Abstract Classes
KuzzleError
toJSON
toJSON
#
Converts a KuzzleError object to a plain-old JSON object.
toJSON
():
JSONObject