Definition of a message sent via websocket connection.

Hierarchy (View Summary)

Constructors

Properties

createdAt: Date

The date at which the message was created.

data: unknown

The actual data of the message.

error: undefined | HttpError

An error that was caused.

The event to send to.

id: string

The uuid (universal unique identifier) of the entity.

ok: boolean

Whether or not the message is ok.

recipientId: undefined | string

The id of th either the channel or the user that this message was sent to. Can be empty when the message was sent to all or to a non user connection.

recipientType: WebsocketRecipientType

The type of recipient. Can be "USER", "CHANNEL", "ALL".

senderConnectionId: undefined | string

The of the connection that has sent the message.

senderUserId: undefined | string

The id of the user that has sent the message.

seq: number

An incremental number that can be used with a client offset to sync server state back to the client.

status: HttpStatus

The http status code.