File tree Expand file tree Collapse file tree
src/reference/sdks/frontend Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -194,6 +194,12 @@ Utilities to interact with frontend-plugin storage.
194194
195195Utilities to create UI components.
196196
197+ ##### websocket
198+
199+ > ** websocket** : [ ` WebsocketSDK ` ] ( websockets.md#websocketsdk )
200+
201+ Utilities to interact with the Websocket page.
202+
197203##### window
198204
199205> ** window** : [ ` WindowSDK ` ] ( window.md#windowsdk )
Original file line number Diff line number Diff line change 11# Websockets
22
3+ ### MessageViewModeOptions
4+
5+ > ** MessageViewModeOptions** = ` object `
6+
7+ Options for defining a custom message view mode.
8+
9+ #### Properties
10+
11+ ##### label
12+
13+ > ** label** : ` string `
14+
15+ The label of the view mode.
16+
17+ ##### view
18+
19+ > ** view** : [ ` ComponentDefinition ` ] ( utils.md#componentdefinition )
20+
21+ The component to render when the view mode is selected.
22+
23+ ##### when()?
24+
25+ > ` optional ` ** when** : (` message ` : [ ` StreamWsMessageMeta ` ] ( #streamwsmessagemeta ) ) => ` boolean `
26+
27+ A function that determines if the view mode should be shown for a given message.
28+
29+ ###### Parameters
30+
31+ | Parameter | Type |
32+ | ------ | ------ |
33+ | ` message ` | [ ` StreamWsMessageMeta ` ] ( #streamwsmessagemeta ) |
34+
35+ ###### Returns
36+
37+ ` boolean `
38+
39+ ***
40+
41+ ### StreamWsMessageMeta
42+
43+ > ** StreamWsMessageMeta** = [ ` Prettify ` ] ( utils.md#prettify ) \< [ ` As ` ] ( utils.md#as ) \< ` "StreamWsMessageMeta" ` \> & ` object ` \>
44+
45+ A complete message with all metadata and raw content.
46+
47+ ***
48+
349### WebsocketPageContext
450
551> ** WebsocketPageContext** = ` object `
@@ -11,3 +57,29 @@ Certificate page context.
1157##### kind
1258
1359> ** kind** : ` "Websocket" `
60+
61+ ***
62+
63+ ### WebsocketSDK
64+
65+ > ** WebsocketSDK** = ` object `
66+
67+ Utilities to interact with websockets
68+
69+ #### Properties
70+
71+ ##### addMessageViewMode()
72+
73+ > ** addMessageViewMode** : (` options ` : [ ` MessageViewModeOptions ` ] ( #messageviewmodeoptions ) ) => ` void `
74+
75+ Add a custom message view mode.
76+
77+ ###### Parameters
78+
79+ | Parameter | Type | Description |
80+ | ------ | ------ | ------ |
81+ | ` options ` | [ ` MessageViewModeOptions ` ] ( #messageviewmodeoptions ) | The view mode options. |
82+
83+ ###### Returns
84+
85+ ` void `
You can’t perform that action at this time.
0 commit comments