Response #
This class represents a raw Kuzzle API response.
Namespace #
You must include the following namespace:
using KuzzleSdk.API;
Properties #
Property | Type | Description | writable |
---|---|---|---|
Action | string | Executed Kuzzle API controller's action | no |
Controller | string | Executed Kuzzle API controller | no |
Collection | string | Impacted data collection | no |
Error | ErrorResponse | Error object (null if the request finished successfully) | no |
Index | string | Impacted data index | no |
RequestId | string | Request unique identifier | no |
Result | JToken | Response payload (depends on the executed API action) | no |
Status | int | Response status, following HTTP status codes | no |
Volatile | JObject | Volatile data | no |
Properties specific to real-time notifications
Property | Type | Description | writable |
---|---|---|---|
Protocol | string | Network protocol at the origin of the real-time notification | no |
Room | string | Room unique identifier | no |
Scope | string | Document scope ("in" or "out") | no |
State | string | Document state | no |
Timestamp | long | Notification timestamp (UTC) | no |
Type | string | Notification type | no |
Edit this page on Github(opens new window)