Core
Framework v2.x
2

KuzzleRequest #

The KuzzleRequest class represents a request processed by Kuzzle.

It contains every information used internally by Kuzzle to process the request like the client inputs, but also the response that will be sent back to the client.

This object is received by the controller's actions handler function and it's also the payload of many internal events (e.g API Events)

context #

Type Description get / set
RequestContext
KuzzleRequest context (e.g. user, connection, jwt) get

deprecations #

Type Description get / set
Deprecation[]
Array of deprecation warnings associated to the request get

error #

Type Description get / set
KuzzleError
One of the API Error or null get

id #

Type Description get / set
string
KuzzleRequest external unique identifier get / set

Correspond to the requestId property passed in the RequestPayload.

input #

Type Description get / set
RequestInput
KuzzleRequest arguments and body get

internalId #

Type Description get / set
string
KuzzleRequest internal unique identifier get

response #

Type Description get / set
RequestResponse
KuzzleRequest response object get

result #

Type Description get / set
any
KuzzleRequest result get / set

status #

Type Description get / set
number
KuzzleRequest HTTP status get / set

timestamp #

Type Description get / set
number
KuzzleRequest timestamp (in Epoch-micro) get