Interface KristWsS2CResponseMessage

An incoming message sent from the Krist server to a websocket client.

Hierarchy

Properties

error id message ok parameter responding_to_type type

Properties

Optional error

error?: string

If ok is false, the error code from the Krist API.

id

id: number

The message ID that this is in response to. You typically do not need to do anything with this, the library will handle message replies automatically.

Optional message

message?: string

If ok is false, a human-readable error message from the Krist API.

ok

ok: boolean

Whether the request succeeded.

Optional parameter

parameter?: string

If ok is false, the parameter that caused the error (if available).

responding_to_type

responding_to_type: KristWsMessageType

The type of message that the server is responding to.

type

type: "response"

The type of incoming message.

Settings

Member Visibility

Theme

Generated using TypeDoc