Interface KristWsS2CMessage

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

Hierarchy

Properties

error message ok parameter type

Properties

Optional error

error?: string

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

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).

type

type: KristWsS2CMessageType

The type of incoming message.

Settings

Member Visibility

Theme

Generated using TypeDoc