Websockets

MessageViewModeOptions

MessageViewModeOptions<TProps> = object

Options for defining a custom message view mode.

Type Parameters

Type Parameter
TProps extends MessageViewModeProps | MessageViewModePropsInternal

Properties

label

label: string

The label of the view mode.

view

view: ComponentDefinition<TProps>

The component to render when the view mode is selected.

when()?

optional when: (message: StreamWsMessageMeta) => boolean

A function that determines if the view mode should be shown for a given message.

Parameters

Parameter	Type
message	StreamWsMessageMeta

Returns

boolean

---

MessageViewModeProps

MessageViewModeProps = ComponentPropsWithSdk<MessageViewModePropsInternal>

The props for the message view mode.

---

MessageViewModePropsInternal

MessageViewModePropsInternal = object

The internal props for the message view mode.

Properties

message

message: StreamWsMessageMeta

view

view: EditorView

---

StreamWsMessageMeta

StreamWsMessageMeta = Prettify<As<"StreamWsMessageMeta"> & object>

A complete message with all metadata and raw content.

---

WebsocketPageContext

WebsocketPageContext = object

Certificate page context.

Properties

kind

kind: "Websocket"

---

WebsocketSDK

WebsocketSDK = object

Utilities to interact with websockets

Properties

addMessageViewMode()

addMessageViewMode: (options: MessageViewModeOptions<MessageViewModeProps>) => void

Add a custom message view mode.

Parameters

Parameter	Type	Description
options	MessageViewModeOptions<MessageViewModeProps>	The view mode options.

Returns

void