API request arguments are accessible here.
Common arguments are accessible at the root level: jwt, volatile, body, controller, action
Every other arguments are accessible under the args property. E.g: _id, index, collection, refresh, onExistingUser, foobar, etc.
action #
| Type | Description | get / set |
|---|
string | API action name (null if not set). Can only be set once | get / set |
args #
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest arguments (except body) | get / set |
body #
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest body (null if not set) | get / set |
controller #
| Type | Description | get / set |
|---|
string | API controller name (null if not set). Can only be set once | get / set |
Deprecated since 2.16.3
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest headers (Http only) | get / set |
jwt #
| Type | Description | get / set |
|---|
string | Authentication token (null if not set) | get / set |
resource #
Deprecated since 2.11.0
| Type | Description | get / set |
|---|
JSONObject | Class containing Kuzzle specific arguments | get |
Specific arguments #
| name | Type | Description | get / set |
|---|
resource._id | string | Document ID | get |
resource.index | string | Index name | get |
resource.collection | string | Collection name | get |
triggerEvents #
Available since 2.31.0
| Type | Description | get / set |
|---|
boolean | true if a request executed with the EmbeddedSDK triggers the API events (undefined otherwise) | get / set |
See Trigger events.
volatile #
| Type | Description | get / set |
|---|
JSONObject | Volatile data sent with the request (null if not set) | get / set |