Core
Framework v2.x
2
Kuzzle Backend v2
Kuzzle IoT v4
Kuzzle IoT v3
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Search
Ctrl
K
Discover Kuzzle
Kuzzle Backend v2
Kuzzle IoT v4
Kuzzle IoT v3
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Classes
Backend
Constructor
Properties
install
start
trigger
BackendCluster
Properties
broadcast
off
on
once
removeAllListeners
BackendConfig
Properties
merge
set
BackendController
Properties
register
use
BackendErrors
get
getFrom
register
BackendHook
Properties
register
BackendImport
Properties
mappings
profiles
roles
userMappings
users
BackendOpenApi
Properties
BackendPipe
Properties
register
BackendPlugin
Properties
get
list
use
BackendStorage
Properties
BackendSubscription
Properties
add
remove
BackendVault
Properties
DataValidation
Properties
addType
validate
EmbeddedSDK
Properties
as
HttpStream
Properties
constructor
Inflector
camelCase
kebabCase
pascalCase
snakeCase
upFirst
InternalLogger
Properties
debug
info
use
verbose
warn
Koncorde
Properties
exists
getFilterIds
normalize
register
remove
store
test
validate
KuzzleRequest
Properties
addDeprecation
clearError
getArray
getBody
getBodyArray
getBodyBoolean
getBodyInteger
getBodyNumber
getBodyObject
getBodyString
getBoolean
getCollection
getId
getIndex
getIndexAndCollection
getInteger
getKuid
getLangParam
getNumber
getObject
getRefresh
getSearchBody
getSearchParams
getString
getUser
serialize
setError
setResult
Mutex
Constructor
Properties
lock
unlock
wait
NameGenerator
generateRandomName
getRandomAdjective
getRandomName
PluginContext
Properties
PluginContextAccessors
Properties
execute
trigger
PluginContextConstructors
Properties
execute
PluginStorage
Properties
bootstrap
createCollection
PluginStrategy
Properties
add
remove
Repository
Properties
contructor
create
createOrReplace
delete
get
mGet
replace
scroll
search
update
RequestContext
Properties
RequestInput
Properties
RequestResponse
Properties
configure
Subscription
Properties
register
unregister
Abstract Classes
BaseValidationType
Properties
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
NotFoundError
Constructor
Properties
PartialError
Constructor
Properties
PluginImplementationError
Constructor
Properties
PreconditionError
Constructor
Properties
ServiceUnavailableError
Constructor
Properties
SizeLimitError
Constructor
Properties
UnauthorizedError
Constructor
Properties
Types
ControllerDefinition
Deprecation
EventHandler
PluginManifest
RequestPayload
ResponsePayload
StrategyDefinition
Events
API
Auth
Connection
Core
Generic Document
HTTP
Hook
Kuzzle
Plugin
Realtime
Request
Websocket
Wildcard
Services
Redirecting...