@wix/realtime 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/build/index.d.ts +4 -0
- package/cjs/build/index.js +4 -1
- package/cjs/build/publisher/publisher.context.d.ts +9 -4
- package/cjs/build/publisher/publisher.context.js +9 -4
- package/cjs/build/subscriber/subscriber.context.d.ts +77 -0
- package/cjs/build/subscriber/subscriber.context.js +77 -0
- package/cjs/build/subscriber/subscriber.public.d.ts +0 -8
- package/cjs/build/subscriber/subscriber.public.js +0 -8
- package/cjs/build/types.d.ts +1 -1
- package/dist/statics/docs-ts-model.json +1430 -64
- package/es/build/index.d.ts +4 -0
- package/es/build/index.js +2 -0
- package/es/build/publisher/publisher.context.d.ts +9 -4
- package/es/build/publisher/publisher.context.js +9 -4
- package/es/build/subscriber/subscriber.context.d.ts +77 -0
- package/es/build/subscriber/subscriber.context.js +77 -0
- package/es/build/subscriber/subscriber.public.d.ts +0 -8
- package/es/build/subscriber/subscriber.public.js +0 -8
- package/es/build/types.d.ts +1 -1
- package/package.json +4 -4
|
@@ -30,15 +30,7 @@
|
|
|
30
30
|
"summary": [
|
|
31
31
|
{
|
|
32
32
|
"kind": "text",
|
|
33
|
-
"text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n"
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"kind": "code",
|
|
37
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { publisher },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"kind": "text",
|
|
41
|
-
"text": "\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
|
|
33
|
+
"text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
|
|
42
34
|
},
|
|
43
35
|
{
|
|
44
36
|
"kind": "code",
|
|
@@ -46,11 +38,35 @@
|
|
|
46
38
|
},
|
|
47
39
|
{
|
|
48
40
|
"kind": "text",
|
|
49
|
-
"text": " to obtain the host's backend credentials
|
|
41
|
+
"text": " to obtain the host's backend credentials."
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"blockTags": [
|
|
45
|
+
{
|
|
46
|
+
"tag": "@example",
|
|
47
|
+
"content": [
|
|
48
|
+
{
|
|
49
|
+
"kind": "text",
|
|
50
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"kind": "code",
|
|
54
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { publisher },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
55
|
+
}
|
|
56
|
+
]
|
|
50
57
|
},
|
|
51
58
|
{
|
|
52
|
-
"
|
|
53
|
-
"
|
|
59
|
+
"tag": "@example",
|
|
60
|
+
"content": [
|
|
61
|
+
{
|
|
62
|
+
"kind": "text",
|
|
63
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"kind": "code",
|
|
67
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
68
|
+
}
|
|
69
|
+
]
|
|
54
70
|
}
|
|
55
71
|
]
|
|
56
72
|
},
|
|
@@ -61,12 +77,17 @@
|
|
|
61
77
|
"variant": "param",
|
|
62
78
|
"kind": 32768,
|
|
63
79
|
"flags": {},
|
|
80
|
+
"comment": {
|
|
81
|
+
"summary": [
|
|
82
|
+
{
|
|
83
|
+
"kind": "text",
|
|
84
|
+
"text": "The channel, and optionally the resource, to publish to."
|
|
85
|
+
}
|
|
86
|
+
]
|
|
87
|
+
},
|
|
64
88
|
"type": {
|
|
65
89
|
"type": "reference",
|
|
66
|
-
"target":
|
|
67
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
68
|
-
"qualifiedName": "Channel"
|
|
69
|
-
},
|
|
90
|
+
"target": 43,
|
|
70
91
|
"name": "Channel",
|
|
71
92
|
"package": "@wix/realtime-common"
|
|
72
93
|
}
|
|
@@ -77,6 +98,14 @@
|
|
|
77
98
|
"variant": "param",
|
|
78
99
|
"kind": 32768,
|
|
79
100
|
"flags": {},
|
|
101
|
+
"comment": {
|
|
102
|
+
"summary": [
|
|
103
|
+
{
|
|
104
|
+
"kind": "text",
|
|
105
|
+
"text": "Message payload. Max: 10kb"
|
|
106
|
+
}
|
|
107
|
+
]
|
|
108
|
+
},
|
|
80
109
|
"type": {
|
|
81
110
|
"type": "reference",
|
|
82
111
|
"target": {
|
|
@@ -124,15 +153,7 @@
|
|
|
124
153
|
"summary": [
|
|
125
154
|
{
|
|
126
155
|
"kind": "text",
|
|
127
|
-
"text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n"
|
|
128
|
-
},
|
|
129
|
-
{
|
|
130
|
-
"kind": "code",
|
|
131
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { publisher },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
132
|
-
},
|
|
133
|
-
{
|
|
134
|
-
"kind": "text",
|
|
135
|
-
"text": "\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
|
|
156
|
+
"text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
|
|
136
157
|
},
|
|
137
158
|
{
|
|
138
159
|
"kind": "code",
|
|
@@ -140,11 +161,35 @@
|
|
|
140
161
|
},
|
|
141
162
|
{
|
|
142
163
|
"kind": "text",
|
|
143
|
-
"text": " to obtain the host's backend credentials
|
|
164
|
+
"text": " to obtain the host's backend credentials."
|
|
165
|
+
}
|
|
166
|
+
],
|
|
167
|
+
"blockTags": [
|
|
168
|
+
{
|
|
169
|
+
"tag": "@example",
|
|
170
|
+
"content": [
|
|
171
|
+
{
|
|
172
|
+
"kind": "text",
|
|
173
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"kind": "code",
|
|
177
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { publisher },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
178
|
+
}
|
|
179
|
+
]
|
|
144
180
|
},
|
|
145
181
|
{
|
|
146
|
-
"
|
|
147
|
-
"
|
|
182
|
+
"tag": "@example",
|
|
183
|
+
"content": [
|
|
184
|
+
{
|
|
185
|
+
"kind": "text",
|
|
186
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"kind": "code",
|
|
190
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
|
|
191
|
+
}
|
|
192
|
+
]
|
|
148
193
|
}
|
|
149
194
|
]
|
|
150
195
|
},
|
|
@@ -332,10 +377,7 @@
|
|
|
332
377
|
},
|
|
333
378
|
"type": {
|
|
334
379
|
"type": "reference",
|
|
335
|
-
"target":
|
|
336
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
337
|
-
"qualifiedName": "Channel"
|
|
338
|
-
},
|
|
380
|
+
"target": 43,
|
|
339
381
|
"name": "Channel",
|
|
340
382
|
"package": "@wix/realtime-common"
|
|
341
383
|
}
|
|
@@ -466,10 +508,7 @@
|
|
|
466
508
|
},
|
|
467
509
|
"type": {
|
|
468
510
|
"type": "reference",
|
|
469
|
-
"target":
|
|
470
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
471
|
-
"qualifiedName": "Channel"
|
|
472
|
-
},
|
|
511
|
+
"target": 43,
|
|
473
512
|
"name": "Channel",
|
|
474
513
|
"package": "@wix/realtime-common"
|
|
475
514
|
}
|
|
@@ -793,10 +832,7 @@
|
|
|
793
832
|
},
|
|
794
833
|
"type": {
|
|
795
834
|
"type": "reference",
|
|
796
|
-
"target":
|
|
797
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
798
|
-
"qualifiedName": "Channel"
|
|
799
|
-
},
|
|
835
|
+
"target": 43,
|
|
800
836
|
"name": "Channel",
|
|
801
837
|
"package": "@wix/realtime-common"
|
|
802
838
|
}
|
|
@@ -916,6 +952,50 @@
|
|
|
916
952
|
"variant": "signature",
|
|
917
953
|
"kind": 4096,
|
|
918
954
|
"flags": {},
|
|
955
|
+
"comment": {
|
|
956
|
+
"summary": [
|
|
957
|
+
{
|
|
958
|
+
"kind": "text",
|
|
959
|
+
"text": "Subscribe to a channel. Returns a subscriptionId immediately; the\nactual connection is established asynchronously in the background. Use the\noptional "
|
|
960
|
+
},
|
|
961
|
+
{
|
|
962
|
+
"kind": "code",
|
|
963
|
+
"text": "`options`"
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"kind": "text",
|
|
967
|
+
"text": " parameter to handle subscription lifecycle events."
|
|
968
|
+
}
|
|
969
|
+
],
|
|
970
|
+
"blockTags": [
|
|
971
|
+
{
|
|
972
|
+
"tag": "@example",
|
|
973
|
+
"content": [
|
|
974
|
+
{
|
|
975
|
+
"kind": "text",
|
|
976
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"kind": "code",
|
|
980
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { subscriber },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n { name: 'my-channel' },\n (message, channel) => {\n console.log('Received:', message.payload);\n },\n {\n onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n onSubscriptionError: (error, id) => console.error('Error', error),\n },\n);\n```"
|
|
981
|
+
}
|
|
982
|
+
]
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"tag": "@example",
|
|
986
|
+
"content": [
|
|
987
|
+
{
|
|
988
|
+
"kind": "text",
|
|
989
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"kind": "code",
|
|
993
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n { name: 'my-channel' },\n (message, channel) => {\n console.log('Received:', message.payload);\n },\n);\n```"
|
|
994
|
+
}
|
|
995
|
+
]
|
|
996
|
+
}
|
|
997
|
+
]
|
|
998
|
+
},
|
|
919
999
|
"parameters": [
|
|
920
1000
|
{
|
|
921
1001
|
"id": 33,
|
|
@@ -923,12 +1003,17 @@
|
|
|
923
1003
|
"variant": "param",
|
|
924
1004
|
"kind": 32768,
|
|
925
1005
|
"flags": {},
|
|
1006
|
+
"comment": {
|
|
1007
|
+
"summary": [
|
|
1008
|
+
{
|
|
1009
|
+
"kind": "text",
|
|
1010
|
+
"text": "The channel, and optionally the resource, to subscribe to."
|
|
1011
|
+
}
|
|
1012
|
+
]
|
|
1013
|
+
},
|
|
926
1014
|
"type": {
|
|
927
1015
|
"type": "reference",
|
|
928
|
-
"target":
|
|
929
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
930
|
-
"qualifiedName": "Channel"
|
|
931
|
-
},
|
|
1016
|
+
"target": 43,
|
|
932
1017
|
"name": "Channel",
|
|
933
1018
|
"package": "@wix/realtime-common"
|
|
934
1019
|
}
|
|
@@ -939,12 +1024,17 @@
|
|
|
939
1024
|
"variant": "param",
|
|
940
1025
|
"kind": 32768,
|
|
941
1026
|
"flags": {},
|
|
1027
|
+
"comment": {
|
|
1028
|
+
"summary": [
|
|
1029
|
+
{
|
|
1030
|
+
"kind": "text",
|
|
1031
|
+
"text": "Callback invoked whenever a message is published to the channel."
|
|
1032
|
+
}
|
|
1033
|
+
]
|
|
1034
|
+
},
|
|
942
1035
|
"type": {
|
|
943
1036
|
"type": "reference",
|
|
944
|
-
"target":
|
|
945
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
946
|
-
"qualifiedName": "MessageHandler"
|
|
947
|
-
},
|
|
1037
|
+
"target": 49,
|
|
948
1038
|
"name": "MessageHandler",
|
|
949
1039
|
"package": "@wix/realtime-common"
|
|
950
1040
|
}
|
|
@@ -957,12 +1047,17 @@
|
|
|
957
1047
|
"flags": {
|
|
958
1048
|
"isOptional": true
|
|
959
1049
|
},
|
|
1050
|
+
"comment": {
|
|
1051
|
+
"summary": [
|
|
1052
|
+
{
|
|
1053
|
+
"kind": "text",
|
|
1054
|
+
"text": "Optional lifecycle handlers for subscription events."
|
|
1055
|
+
}
|
|
1056
|
+
]
|
|
1057
|
+
},
|
|
960
1058
|
"type": {
|
|
961
1059
|
"type": "reference",
|
|
962
|
-
"target":
|
|
963
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
964
|
-
"qualifiedName": "SubscriptionOptions"
|
|
965
|
-
},
|
|
1060
|
+
"target": 66,
|
|
966
1061
|
"name": "SubscriptionOptions",
|
|
967
1062
|
"package": "@wix/realtime-common"
|
|
968
1063
|
}
|
|
@@ -993,6 +1088,34 @@
|
|
|
993
1088
|
"kind": "text",
|
|
994
1089
|
"text": " parameter to handle subscription lifecycle events."
|
|
995
1090
|
}
|
|
1091
|
+
],
|
|
1092
|
+
"blockTags": [
|
|
1093
|
+
{
|
|
1094
|
+
"tag": "@example",
|
|
1095
|
+
"content": [
|
|
1096
|
+
{
|
|
1097
|
+
"kind": "text",
|
|
1098
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"kind": "code",
|
|
1102
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { subscriber },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n { name: 'my-channel' },\n (message, channel) => {\n console.log('Received:', message.payload);\n },\n {\n onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n onSubscriptionError: (error, id) => console.error('Error', error),\n },\n);\n```"
|
|
1103
|
+
}
|
|
1104
|
+
]
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"tag": "@example",
|
|
1108
|
+
"content": [
|
|
1109
|
+
{
|
|
1110
|
+
"kind": "text",
|
|
1111
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"kind": "code",
|
|
1115
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n { name: 'my-channel' },\n (message, channel) => {\n console.log('Received:', message.payload);\n },\n);\n```"
|
|
1116
|
+
}
|
|
1117
|
+
]
|
|
1118
|
+
}
|
|
996
1119
|
]
|
|
997
1120
|
},
|
|
998
1121
|
"parameters": [
|
|
@@ -1038,6 +1161,58 @@
|
|
|
1038
1161
|
"variant": "signature",
|
|
1039
1162
|
"kind": 4096,
|
|
1040
1163
|
"flags": {},
|
|
1164
|
+
"comment": {
|
|
1165
|
+
"summary": [
|
|
1166
|
+
{
|
|
1167
|
+
"kind": "text",
|
|
1168
|
+
"text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three ways:\n- By "
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"kind": "code",
|
|
1172
|
+
"text": "`subscriptionId`"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"kind": "text",
|
|
1176
|
+
"text": " — removes a single subscription.\n- By "
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"kind": "code",
|
|
1180
|
+
"text": "`channel`"
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"kind": "text",
|
|
1184
|
+
"text": " — removes all subscriptions to that channel.\n- By both — removes the specific subscription, verifying it matches the channel."
|
|
1185
|
+
}
|
|
1186
|
+
],
|
|
1187
|
+
"blockTags": [
|
|
1188
|
+
{
|
|
1189
|
+
"tag": "@example",
|
|
1190
|
+
"content": [
|
|
1191
|
+
{
|
|
1192
|
+
"kind": "text",
|
|
1193
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
"kind": "code",
|
|
1197
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { subscriber },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\n// Unsubscribe by subscription ID\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Unsubscribe from all subscriptions to a channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
|
|
1198
|
+
}
|
|
1199
|
+
]
|
|
1200
|
+
},
|
|
1201
|
+
{
|
|
1202
|
+
"tag": "@example",
|
|
1203
|
+
"content": [
|
|
1204
|
+
{
|
|
1205
|
+
"kind": "text",
|
|
1206
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"kind": "code",
|
|
1210
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
|
|
1211
|
+
}
|
|
1212
|
+
]
|
|
1213
|
+
}
|
|
1214
|
+
]
|
|
1215
|
+
},
|
|
1041
1216
|
"parameters": [
|
|
1042
1217
|
{
|
|
1043
1218
|
"id": 40,
|
|
@@ -1045,12 +1220,17 @@
|
|
|
1045
1220
|
"variant": "param",
|
|
1046
1221
|
"kind": 32768,
|
|
1047
1222
|
"flags": {},
|
|
1223
|
+
"comment": {
|
|
1224
|
+
"summary": [
|
|
1225
|
+
{
|
|
1226
|
+
"kind": "text",
|
|
1227
|
+
"text": "Identifies what to unsubscribe from — by subscription ID, channel, or both."
|
|
1228
|
+
}
|
|
1229
|
+
]
|
|
1230
|
+
},
|
|
1048
1231
|
"type": {
|
|
1049
1232
|
"type": "reference",
|
|
1050
|
-
"target":
|
|
1051
|
-
"sourceFileName": "../realtime-common/cjs/build/types.d.ts",
|
|
1052
|
-
"qualifiedName": "UnsubscribeOptions"
|
|
1053
|
-
},
|
|
1233
|
+
"target": 69,
|
|
1054
1234
|
"name": "UnsubscribeOptions",
|
|
1055
1235
|
"package": "@wix/realtime-common"
|
|
1056
1236
|
}
|
|
@@ -1071,7 +1251,51 @@
|
|
|
1071
1251
|
"summary": [
|
|
1072
1252
|
{
|
|
1073
1253
|
"kind": "text",
|
|
1074
|
-
"text": "Unsubscribe from a subscription by its ID, by channel, or both
|
|
1254
|
+
"text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three ways:\n- By "
|
|
1255
|
+
},
|
|
1256
|
+
{
|
|
1257
|
+
"kind": "code",
|
|
1258
|
+
"text": "`subscriptionId`"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"kind": "text",
|
|
1262
|
+
"text": " — removes a single subscription.\n- By "
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"kind": "code",
|
|
1266
|
+
"text": "`channel`"
|
|
1267
|
+
},
|
|
1268
|
+
{
|
|
1269
|
+
"kind": "text",
|
|
1270
|
+
"text": " — removes all subscriptions to that channel.\n- By both — removes the specific subscription, verifying it matches the channel."
|
|
1271
|
+
}
|
|
1272
|
+
],
|
|
1273
|
+
"blockTags": [
|
|
1274
|
+
{
|
|
1275
|
+
"tag": "@example",
|
|
1276
|
+
"content": [
|
|
1277
|
+
{
|
|
1278
|
+
"kind": "text",
|
|
1279
|
+
"text": "Manual client (self-hosted / explicit auth)\n"
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"kind": "code",
|
|
1283
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n modules: { subscriber },\n auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\n// Unsubscribe by subscription ID\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Unsubscribe from all subscriptions to a channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
|
|
1284
|
+
}
|
|
1285
|
+
]
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
"tag": "@example",
|
|
1289
|
+
"content": [
|
|
1290
|
+
{
|
|
1291
|
+
"kind": "text",
|
|
1292
|
+
"text": "Contextual client (Wix-hosted)\n"
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"kind": "code",
|
|
1296
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
|
|
1297
|
+
}
|
|
1298
|
+
]
|
|
1075
1299
|
}
|
|
1076
1300
|
]
|
|
1077
1301
|
},
|
|
@@ -1115,15 +1339,1157 @@
|
|
|
1115
1339
|
]
|
|
1116
1340
|
}
|
|
1117
1341
|
]
|
|
1118
|
-
}
|
|
1119
|
-
],
|
|
1120
|
-
"groups": [
|
|
1342
|
+
},
|
|
1121
1343
|
{
|
|
1122
|
-
"
|
|
1344
|
+
"id": 86,
|
|
1345
|
+
"name": "RealtimeErrorCode",
|
|
1346
|
+
"variant": "declaration",
|
|
1347
|
+
"kind": 8,
|
|
1348
|
+
"flags": {},
|
|
1349
|
+
"comment": {
|
|
1350
|
+
"summary": [
|
|
1351
|
+
{
|
|
1352
|
+
"kind": "text",
|
|
1353
|
+
"text": "Error codes for realtime errors."
|
|
1354
|
+
}
|
|
1355
|
+
]
|
|
1356
|
+
},
|
|
1123
1357
|
"children": [
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1358
|
+
{
|
|
1359
|
+
"id": 90,
|
|
1360
|
+
"name": "BadInput",
|
|
1361
|
+
"variant": "declaration",
|
|
1362
|
+
"kind": 16,
|
|
1363
|
+
"flags": {},
|
|
1364
|
+
"comment": {
|
|
1365
|
+
"summary": [
|
|
1366
|
+
{
|
|
1367
|
+
"kind": "text",
|
|
1368
|
+
"text": "Invalid input (e.g. bad channel name)."
|
|
1369
|
+
}
|
|
1370
|
+
]
|
|
1371
|
+
},
|
|
1372
|
+
"type": {
|
|
1373
|
+
"type": "literal",
|
|
1374
|
+
"value": "BAD_INPUT"
|
|
1375
|
+
}
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"id": 88,
|
|
1379
|
+
"name": "ConnectionError",
|
|
1380
|
+
"variant": "declaration",
|
|
1381
|
+
"kind": 16,
|
|
1382
|
+
"flags": {},
|
|
1383
|
+
"comment": {
|
|
1384
|
+
"summary": [
|
|
1385
|
+
{
|
|
1386
|
+
"kind": "text",
|
|
1387
|
+
"text": "A connection attempt failed. The client keeps retrying automatically."
|
|
1388
|
+
}
|
|
1389
|
+
]
|
|
1390
|
+
},
|
|
1391
|
+
"type": {
|
|
1392
|
+
"type": "literal",
|
|
1393
|
+
"value": "CONNECTION_ERROR"
|
|
1394
|
+
}
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"id": 87,
|
|
1398
|
+
"name": "Disconnected",
|
|
1399
|
+
"variant": "declaration",
|
|
1400
|
+
"kind": 16,
|
|
1401
|
+
"flags": {},
|
|
1402
|
+
"comment": {
|
|
1403
|
+
"summary": [
|
|
1404
|
+
{
|
|
1405
|
+
"kind": "text",
|
|
1406
|
+
"text": "The connection was closed, either intentionally or due to an error."
|
|
1407
|
+
}
|
|
1408
|
+
]
|
|
1409
|
+
},
|
|
1410
|
+
"type": {
|
|
1411
|
+
"type": "literal",
|
|
1412
|
+
"value": "DISCONNECTED"
|
|
1413
|
+
}
|
|
1414
|
+
},
|
|
1415
|
+
{
|
|
1416
|
+
"id": 89,
|
|
1417
|
+
"name": "SubscriptionFailed",
|
|
1418
|
+
"variant": "declaration",
|
|
1419
|
+
"kind": 16,
|
|
1420
|
+
"flags": {},
|
|
1421
|
+
"comment": {
|
|
1422
|
+
"summary": [
|
|
1423
|
+
{
|
|
1424
|
+
"kind": "text",
|
|
1425
|
+
"text": "The subscription request failed (e.g. authorization error)."
|
|
1426
|
+
}
|
|
1427
|
+
]
|
|
1428
|
+
},
|
|
1429
|
+
"type": {
|
|
1430
|
+
"type": "literal",
|
|
1431
|
+
"value": "SUBSCRIPTION_FAILED"
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
],
|
|
1435
|
+
"groups": [
|
|
1436
|
+
{
|
|
1437
|
+
"title": "Enumeration Members",
|
|
1438
|
+
"children": [
|
|
1439
|
+
90,
|
|
1440
|
+
88,
|
|
1441
|
+
87,
|
|
1442
|
+
89
|
|
1443
|
+
]
|
|
1444
|
+
}
|
|
1445
|
+
]
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
"id": 72,
|
|
1449
|
+
"name": "RealtimeError",
|
|
1450
|
+
"variant": "declaration",
|
|
1451
|
+
"kind": 128,
|
|
1452
|
+
"flags": {},
|
|
1453
|
+
"comment": {
|
|
1454
|
+
"summary": [
|
|
1455
|
+
{
|
|
1456
|
+
"kind": "text",
|
|
1457
|
+
"text": "An object representing an error."
|
|
1458
|
+
}
|
|
1459
|
+
]
|
|
1460
|
+
},
|
|
1461
|
+
"children": [
|
|
1462
|
+
{
|
|
1463
|
+
"id": 73,
|
|
1464
|
+
"name": "constructor",
|
|
1465
|
+
"variant": "declaration",
|
|
1466
|
+
"kind": 512,
|
|
1467
|
+
"flags": {},
|
|
1468
|
+
"signatures": [
|
|
1469
|
+
{
|
|
1470
|
+
"id": 74,
|
|
1471
|
+
"name": "new RealtimeError",
|
|
1472
|
+
"variant": "signature",
|
|
1473
|
+
"kind": 16384,
|
|
1474
|
+
"flags": {},
|
|
1475
|
+
"parameters": [
|
|
1476
|
+
{
|
|
1477
|
+
"id": 75,
|
|
1478
|
+
"name": "errorCode",
|
|
1479
|
+
"variant": "param",
|
|
1480
|
+
"kind": 32768,
|
|
1481
|
+
"flags": {},
|
|
1482
|
+
"type": {
|
|
1483
|
+
"type": "reference",
|
|
1484
|
+
"target": 86,
|
|
1485
|
+
"name": "RealtimeErrorCode",
|
|
1486
|
+
"package": "@wix/realtime-common"
|
|
1487
|
+
}
|
|
1488
|
+
},
|
|
1489
|
+
{
|
|
1490
|
+
"id": 76,
|
|
1491
|
+
"name": "message",
|
|
1492
|
+
"variant": "param",
|
|
1493
|
+
"kind": 32768,
|
|
1494
|
+
"flags": {},
|
|
1495
|
+
"type": {
|
|
1496
|
+
"type": "intrinsic",
|
|
1497
|
+
"name": "string"
|
|
1498
|
+
}
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"id": 77,
|
|
1502
|
+
"name": "options",
|
|
1503
|
+
"variant": "param",
|
|
1504
|
+
"kind": 32768,
|
|
1505
|
+
"flags": {
|
|
1506
|
+
"isOptional": true
|
|
1507
|
+
},
|
|
1508
|
+
"type": {
|
|
1509
|
+
"type": "reflection",
|
|
1510
|
+
"declaration": {
|
|
1511
|
+
"id": 78,
|
|
1512
|
+
"name": "__type",
|
|
1513
|
+
"variant": "declaration",
|
|
1514
|
+
"kind": 65536,
|
|
1515
|
+
"flags": {},
|
|
1516
|
+
"children": [
|
|
1517
|
+
{
|
|
1518
|
+
"id": 79,
|
|
1519
|
+
"name": "channel",
|
|
1520
|
+
"variant": "declaration",
|
|
1521
|
+
"kind": 1024,
|
|
1522
|
+
"flags": {
|
|
1523
|
+
"isOptional": true
|
|
1524
|
+
},
|
|
1525
|
+
"type": {
|
|
1526
|
+
"type": "reference",
|
|
1527
|
+
"target": 43,
|
|
1528
|
+
"name": "Channel",
|
|
1529
|
+
"package": "@wix/realtime-common"
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"id": 80,
|
|
1534
|
+
"name": "recoverable",
|
|
1535
|
+
"variant": "declaration",
|
|
1536
|
+
"kind": 1024,
|
|
1537
|
+
"flags": {
|
|
1538
|
+
"isOptional": true
|
|
1539
|
+
},
|
|
1540
|
+
"type": {
|
|
1541
|
+
"type": "intrinsic",
|
|
1542
|
+
"name": "boolean"
|
|
1543
|
+
}
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
"id": 81,
|
|
1547
|
+
"name": "status",
|
|
1548
|
+
"variant": "declaration",
|
|
1549
|
+
"kind": 1024,
|
|
1550
|
+
"flags": {
|
|
1551
|
+
"isOptional": true
|
|
1552
|
+
},
|
|
1553
|
+
"type": {
|
|
1554
|
+
"type": "intrinsic",
|
|
1555
|
+
"name": "number"
|
|
1556
|
+
}
|
|
1557
|
+
}
|
|
1558
|
+
],
|
|
1559
|
+
"groups": [
|
|
1560
|
+
{
|
|
1561
|
+
"title": "Properties",
|
|
1562
|
+
"children": [
|
|
1563
|
+
79,
|
|
1564
|
+
80,
|
|
1565
|
+
81
|
|
1566
|
+
]
|
|
1567
|
+
}
|
|
1568
|
+
]
|
|
1569
|
+
}
|
|
1570
|
+
}
|
|
1571
|
+
}
|
|
1572
|
+
],
|
|
1573
|
+
"type": {
|
|
1574
|
+
"type": "reference",
|
|
1575
|
+
"target": 72,
|
|
1576
|
+
"name": "RealtimeError",
|
|
1577
|
+
"package": "@wix/realtime-common"
|
|
1578
|
+
},
|
|
1579
|
+
"overwrites": {
|
|
1580
|
+
"type": "reference",
|
|
1581
|
+
"target": -1,
|
|
1582
|
+
"name": "Error.constructor"
|
|
1583
|
+
}
|
|
1584
|
+
}
|
|
1585
|
+
],
|
|
1586
|
+
"overwrites": {
|
|
1587
|
+
"type": "reference",
|
|
1588
|
+
"target": -1,
|
|
1589
|
+
"name": "Error.constructor"
|
|
1590
|
+
}
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"id": 83,
|
|
1594
|
+
"name": "channel",
|
|
1595
|
+
"variant": "declaration",
|
|
1596
|
+
"kind": 1024,
|
|
1597
|
+
"flags": {
|
|
1598
|
+
"isOptional": true
|
|
1599
|
+
},
|
|
1600
|
+
"comment": {
|
|
1601
|
+
"summary": [
|
|
1602
|
+
{
|
|
1603
|
+
"kind": "text",
|
|
1604
|
+
"text": "Channel related to the error."
|
|
1605
|
+
}
|
|
1606
|
+
]
|
|
1607
|
+
},
|
|
1608
|
+
"type": {
|
|
1609
|
+
"type": "reference",
|
|
1610
|
+
"target": 43,
|
|
1611
|
+
"name": "Channel",
|
|
1612
|
+
"package": "@wix/realtime-common"
|
|
1613
|
+
}
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
"id": 82,
|
|
1617
|
+
"name": "errorCode",
|
|
1618
|
+
"variant": "declaration",
|
|
1619
|
+
"kind": 1024,
|
|
1620
|
+
"flags": {},
|
|
1621
|
+
"comment": {
|
|
1622
|
+
"summary": [
|
|
1623
|
+
{
|
|
1624
|
+
"kind": "text",
|
|
1625
|
+
"text": "Error code."
|
|
1626
|
+
}
|
|
1627
|
+
]
|
|
1628
|
+
},
|
|
1629
|
+
"type": {
|
|
1630
|
+
"type": "reference",
|
|
1631
|
+
"target": 86,
|
|
1632
|
+
"name": "RealtimeErrorCode",
|
|
1633
|
+
"package": "@wix/realtime-common"
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
{
|
|
1637
|
+
"id": 84,
|
|
1638
|
+
"name": "recoverable",
|
|
1639
|
+
"variant": "declaration",
|
|
1640
|
+
"kind": 1024,
|
|
1641
|
+
"flags": {
|
|
1642
|
+
"isOptional": true
|
|
1643
|
+
},
|
|
1644
|
+
"comment": {
|
|
1645
|
+
"summary": [
|
|
1646
|
+
{
|
|
1647
|
+
"kind": "text",
|
|
1648
|
+
"text": "Whether the error is recoverable. When "
|
|
1649
|
+
},
|
|
1650
|
+
{
|
|
1651
|
+
"kind": "code",
|
|
1652
|
+
"text": "`true`"
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"kind": "text",
|
|
1656
|
+
"text": ", the client is\nautomatically attempting to reconnect. When "
|
|
1657
|
+
},
|
|
1658
|
+
{
|
|
1659
|
+
"kind": "code",
|
|
1660
|
+
"text": "`false`"
|
|
1661
|
+
},
|
|
1662
|
+
{
|
|
1663
|
+
"kind": "text",
|
|
1664
|
+
"text": ", user action\nis required (for example, the subscription must be re-created)."
|
|
1665
|
+
}
|
|
1666
|
+
]
|
|
1667
|
+
},
|
|
1668
|
+
"type": {
|
|
1669
|
+
"type": "intrinsic",
|
|
1670
|
+
"name": "boolean"
|
|
1671
|
+
}
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"id": 85,
|
|
1675
|
+
"name": "status",
|
|
1676
|
+
"variant": "declaration",
|
|
1677
|
+
"kind": 1024,
|
|
1678
|
+
"flags": {
|
|
1679
|
+
"isOptional": true
|
|
1680
|
+
},
|
|
1681
|
+
"comment": {
|
|
1682
|
+
"summary": [
|
|
1683
|
+
{
|
|
1684
|
+
"kind": "text",
|
|
1685
|
+
"text": "HTTP status code from the server response.\nPresent on subscription failed errors (e.g. 401, 403, 500)."
|
|
1686
|
+
}
|
|
1687
|
+
]
|
|
1688
|
+
},
|
|
1689
|
+
"type": {
|
|
1690
|
+
"type": "intrinsic",
|
|
1691
|
+
"name": "number"
|
|
1692
|
+
}
|
|
1693
|
+
}
|
|
1694
|
+
],
|
|
1695
|
+
"groups": [
|
|
1696
|
+
{
|
|
1697
|
+
"title": "Constructors",
|
|
1698
|
+
"children": [
|
|
1699
|
+
73
|
|
1700
|
+
]
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
"title": "Properties",
|
|
1704
|
+
"children": [
|
|
1705
|
+
83,
|
|
1706
|
+
82,
|
|
1707
|
+
84,
|
|
1708
|
+
85
|
|
1709
|
+
]
|
|
1710
|
+
}
|
|
1711
|
+
],
|
|
1712
|
+
"extendedTypes": [
|
|
1713
|
+
{
|
|
1714
|
+
"type": "reference",
|
|
1715
|
+
"target": {
|
|
1716
|
+
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
1717
|
+
"qualifiedName": "Error"
|
|
1718
|
+
},
|
|
1719
|
+
"name": "Error",
|
|
1720
|
+
"package": "typescript"
|
|
1721
|
+
}
|
|
1722
|
+
]
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"id": 43,
|
|
1726
|
+
"name": "Channel",
|
|
1727
|
+
"variant": "declaration",
|
|
1728
|
+
"kind": 256,
|
|
1729
|
+
"flags": {},
|
|
1730
|
+
"comment": {
|
|
1731
|
+
"summary": [
|
|
1732
|
+
{
|
|
1733
|
+
"kind": "text",
|
|
1734
|
+
"text": "An object representing a realtime channel."
|
|
1735
|
+
}
|
|
1736
|
+
]
|
|
1737
|
+
},
|
|
1738
|
+
"children": [
|
|
1739
|
+
{
|
|
1740
|
+
"id": 44,
|
|
1741
|
+
"name": "name",
|
|
1742
|
+
"variant": "declaration",
|
|
1743
|
+
"kind": 1024,
|
|
1744
|
+
"flags": {},
|
|
1745
|
+
"comment": {
|
|
1746
|
+
"summary": [
|
|
1747
|
+
{
|
|
1748
|
+
"kind": "text",
|
|
1749
|
+
"text": "Channel name. Only alphanumeric characters, hyphens, and underscores are allowed.\nThe combined length of "
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"kind": "code",
|
|
1753
|
+
"text": "`name`"
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"kind": "text",
|
|
1757
|
+
"text": " and "
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"kind": "code",
|
|
1761
|
+
"text": "`resourceId`"
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"kind": "text",
|
|
1765
|
+
"text": " cannot exceed 140 characters."
|
|
1766
|
+
}
|
|
1767
|
+
]
|
|
1768
|
+
},
|
|
1769
|
+
"type": {
|
|
1770
|
+
"type": "intrinsic",
|
|
1771
|
+
"name": "string"
|
|
1772
|
+
}
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"id": 45,
|
|
1776
|
+
"name": "resourceId",
|
|
1777
|
+
"variant": "declaration",
|
|
1778
|
+
"kind": 1024,
|
|
1779
|
+
"flags": {
|
|
1780
|
+
"isOptional": true
|
|
1781
|
+
},
|
|
1782
|
+
"comment": {
|
|
1783
|
+
"summary": [
|
|
1784
|
+
{
|
|
1785
|
+
"kind": "text",
|
|
1786
|
+
"text": "ID of a specific channel resource."
|
|
1787
|
+
}
|
|
1788
|
+
]
|
|
1789
|
+
},
|
|
1790
|
+
"type": {
|
|
1791
|
+
"type": "intrinsic",
|
|
1792
|
+
"name": "string"
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
],
|
|
1796
|
+
"groups": [
|
|
1797
|
+
{
|
|
1798
|
+
"title": "Properties",
|
|
1799
|
+
"children": [
|
|
1800
|
+
44,
|
|
1801
|
+
45
|
|
1802
|
+
]
|
|
1803
|
+
}
|
|
1804
|
+
]
|
|
1805
|
+
},
|
|
1806
|
+
{
|
|
1807
|
+
"id": 46,
|
|
1808
|
+
"name": "Message",
|
|
1809
|
+
"variant": "declaration",
|
|
1810
|
+
"kind": 256,
|
|
1811
|
+
"flags": {},
|
|
1812
|
+
"comment": {
|
|
1813
|
+
"summary": [
|
|
1814
|
+
{
|
|
1815
|
+
"kind": "text",
|
|
1816
|
+
"text": "An object representing a published message."
|
|
1817
|
+
}
|
|
1818
|
+
]
|
|
1819
|
+
},
|
|
1820
|
+
"children": [
|
|
1821
|
+
{
|
|
1822
|
+
"id": 47,
|
|
1823
|
+
"name": "payload",
|
|
1824
|
+
"variant": "declaration",
|
|
1825
|
+
"kind": 1024,
|
|
1826
|
+
"flags": {},
|
|
1827
|
+
"comment": {
|
|
1828
|
+
"summary": [
|
|
1829
|
+
{
|
|
1830
|
+
"kind": "text",
|
|
1831
|
+
"text": "Message payload.\nMax: 10kb"
|
|
1832
|
+
}
|
|
1833
|
+
]
|
|
1834
|
+
},
|
|
1835
|
+
"type": {
|
|
1836
|
+
"type": "reference",
|
|
1837
|
+
"target": {
|
|
1838
|
+
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
1839
|
+
"qualifiedName": "Record"
|
|
1840
|
+
},
|
|
1841
|
+
"typeArguments": [
|
|
1842
|
+
{
|
|
1843
|
+
"type": "intrinsic",
|
|
1844
|
+
"name": "string"
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"type": "intrinsic",
|
|
1848
|
+
"name": "any"
|
|
1849
|
+
}
|
|
1850
|
+
],
|
|
1851
|
+
"name": "Record",
|
|
1852
|
+
"package": "typescript"
|
|
1853
|
+
}
|
|
1854
|
+
},
|
|
1855
|
+
{
|
|
1856
|
+
"id": 48,
|
|
1857
|
+
"name": "publisher",
|
|
1858
|
+
"variant": "declaration",
|
|
1859
|
+
"kind": 1024,
|
|
1860
|
+
"flags": {
|
|
1861
|
+
"isOptional": true
|
|
1862
|
+
},
|
|
1863
|
+
"comment": {
|
|
1864
|
+
"summary": [
|
|
1865
|
+
{
|
|
1866
|
+
"kind": "text",
|
|
1867
|
+
"text": "Message publisher, if sent."
|
|
1868
|
+
}
|
|
1869
|
+
]
|
|
1870
|
+
},
|
|
1871
|
+
"type": {
|
|
1872
|
+
"type": "reference",
|
|
1873
|
+
"target": 54,
|
|
1874
|
+
"name": "Publisher",
|
|
1875
|
+
"package": "@wix/realtime-common"
|
|
1876
|
+
}
|
|
1877
|
+
}
|
|
1878
|
+
],
|
|
1879
|
+
"groups": [
|
|
1880
|
+
{
|
|
1881
|
+
"title": "Properties",
|
|
1882
|
+
"children": [
|
|
1883
|
+
47,
|
|
1884
|
+
48
|
|
1885
|
+
]
|
|
1886
|
+
}
|
|
1887
|
+
]
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
"id": 54,
|
|
1891
|
+
"name": "Publisher",
|
|
1892
|
+
"variant": "declaration",
|
|
1893
|
+
"kind": 256,
|
|
1894
|
+
"flags": {},
|
|
1895
|
+
"comment": {
|
|
1896
|
+
"summary": [
|
|
1897
|
+
{
|
|
1898
|
+
"kind": "text",
|
|
1899
|
+
"text": "An object representing a publisher."
|
|
1900
|
+
}
|
|
1901
|
+
]
|
|
1902
|
+
},
|
|
1903
|
+
"children": [
|
|
1904
|
+
{
|
|
1905
|
+
"id": 55,
|
|
1906
|
+
"name": "id",
|
|
1907
|
+
"variant": "declaration",
|
|
1908
|
+
"kind": 1024,
|
|
1909
|
+
"flags": {},
|
|
1910
|
+
"comment": {
|
|
1911
|
+
"summary": [
|
|
1912
|
+
{
|
|
1913
|
+
"kind": "text",
|
|
1914
|
+
"text": "ID of the publisher."
|
|
1915
|
+
}
|
|
1916
|
+
]
|
|
1917
|
+
},
|
|
1918
|
+
"type": {
|
|
1919
|
+
"type": "intrinsic",
|
|
1920
|
+
"name": "string"
|
|
1921
|
+
}
|
|
1922
|
+
}
|
|
1923
|
+
],
|
|
1924
|
+
"groups": [
|
|
1925
|
+
{
|
|
1926
|
+
"title": "Properties",
|
|
1927
|
+
"children": [
|
|
1928
|
+
55
|
|
1929
|
+
]
|
|
1930
|
+
}
|
|
1931
|
+
]
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"id": 66,
|
|
1935
|
+
"name": "SubscriptionOptions",
|
|
1936
|
+
"variant": "declaration",
|
|
1937
|
+
"kind": 256,
|
|
1938
|
+
"flags": {},
|
|
1939
|
+
"comment": {
|
|
1940
|
+
"summary": [
|
|
1941
|
+
{
|
|
1942
|
+
"kind": "text",
|
|
1943
|
+
"text": "An object containing optional lifecycle handlers for a subscription."
|
|
1944
|
+
}
|
|
1945
|
+
]
|
|
1946
|
+
},
|
|
1947
|
+
"children": [
|
|
1948
|
+
{
|
|
1949
|
+
"id": 67,
|
|
1950
|
+
"name": "onSubscribed",
|
|
1951
|
+
"variant": "declaration",
|
|
1952
|
+
"kind": 1024,
|
|
1953
|
+
"flags": {
|
|
1954
|
+
"isOptional": true
|
|
1955
|
+
},
|
|
1956
|
+
"comment": {
|
|
1957
|
+
"summary": [
|
|
1958
|
+
{
|
|
1959
|
+
"kind": "text",
|
|
1960
|
+
"text": "Runs when the subscription is successfully established.\n\nThis fires on the initial subscription and again every time the\nsubscription is automatically restored after a reconnection, so make\nsure your handler is idempotent.\n\nThe "
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"kind": "code",
|
|
1964
|
+
"text": "`isSynced`"
|
|
1965
|
+
},
|
|
1966
|
+
{
|
|
1967
|
+
"kind": "text",
|
|
1968
|
+
"text": " flag indicates whether the server was able to restore\nmissed messages since the last disconnection:\n\n- **First subscription** — always "
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"kind": "code",
|
|
1972
|
+
"text": "`false`"
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"kind": "text",
|
|
1976
|
+
"text": ". The client has no prior\n message history, so the server cannot restore anything. The app\n should load its own initial state.\n\n- **Re-subscription after reconnect, "
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
"kind": "code",
|
|
1980
|
+
"text": "`isSynced: true`"
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"kind": "text",
|
|
1984
|
+
"text": "** — the server\n found the last received message and replayed everything since.\n No action needed from the app.\n\n- **Re-subscription after reconnect, "
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
"kind": "code",
|
|
1988
|
+
"text": "`isSynced: false`"
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"kind": "text",
|
|
1992
|
+
"text": "** — the server\n could not restore missed messages (e.g. they expired). The app\n should resync its state independently."
|
|
1993
|
+
}
|
|
1994
|
+
],
|
|
1995
|
+
"blockTags": [
|
|
1996
|
+
{
|
|
1997
|
+
"tag": "@param",
|
|
1998
|
+
"name": "subscriptionId",
|
|
1999
|
+
"content": [
|
|
2000
|
+
{
|
|
2001
|
+
"kind": "text",
|
|
2002
|
+
"text": "The ID of the subscription that was established."
|
|
2003
|
+
}
|
|
2004
|
+
]
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"tag": "@param",
|
|
2008
|
+
"name": "isSynced",
|
|
2009
|
+
"content": [
|
|
2010
|
+
{
|
|
2011
|
+
"kind": "text",
|
|
2012
|
+
"text": "Whether the server successfully restored missed messages."
|
|
2013
|
+
}
|
|
2014
|
+
]
|
|
2015
|
+
}
|
|
2016
|
+
]
|
|
2017
|
+
},
|
|
2018
|
+
"type": {
|
|
2019
|
+
"type": "reference",
|
|
2020
|
+
"target": 61,
|
|
2021
|
+
"name": "SubscriptionHandler",
|
|
2022
|
+
"package": "@wix/realtime-common"
|
|
2023
|
+
}
|
|
2024
|
+
},
|
|
2025
|
+
{
|
|
2026
|
+
"id": 68,
|
|
2027
|
+
"name": "onSubscriptionError",
|
|
2028
|
+
"variant": "declaration",
|
|
2029
|
+
"kind": 1024,
|
|
2030
|
+
"flags": {
|
|
2031
|
+
"isOptional": true
|
|
2032
|
+
},
|
|
2033
|
+
"comment": {
|
|
2034
|
+
"summary": [
|
|
2035
|
+
{
|
|
2036
|
+
"kind": "text",
|
|
2037
|
+
"text": "Runs when a subscription error occurs.\n\nThis handler is triggered in the following scenarios:\n\n- **Subscription failed** — Authorization failure. The subscription\n request returned a non-2xx status. The error includes the HTTP\n "
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
"kind": "code",
|
|
2041
|
+
"text": "`status`"
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"kind": "text",
|
|
2045
|
+
"text": " code and a "
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"kind": "code",
|
|
2049
|
+
"text": "`message`"
|
|
2050
|
+
},
|
|
2051
|
+
{
|
|
2052
|
+
"kind": "text",
|
|
2053
|
+
"text": " with details. This is non-recoverable;\n the subscription will not retry automatically.\n\n- **Disconnected** — The connection was closed, either intentionally\n or due to an error. When caused by an error, the "
|
|
2054
|
+
},
|
|
2055
|
+
{
|
|
2056
|
+
"kind": "code",
|
|
2057
|
+
"text": "`recoverable`"
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"kind": "text",
|
|
2061
|
+
"text": " flag\n on the error indicates whether the client will auto-reconnect\n ("
|
|
2062
|
+
},
|
|
2063
|
+
{
|
|
2064
|
+
"kind": "code",
|
|
2065
|
+
"text": "`true`"
|
|
2066
|
+
},
|
|
2067
|
+
{
|
|
2068
|
+
"kind": "text",
|
|
2069
|
+
"text": ") or whether manual action is required ("
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"kind": "code",
|
|
2073
|
+
"text": "`false`"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"kind": "text",
|
|
2077
|
+
"text": ", e.g. a 401\n means the signed instance is invalid).\n\n- **Connection error** — Fired on every reconnection attempt that\n fails. The "
|
|
2078
|
+
},
|
|
2079
|
+
{
|
|
2080
|
+
"kind": "code",
|
|
2081
|
+
"text": "`recoverable`"
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"kind": "text",
|
|
2085
|
+
"text": " flag is always "
|
|
2086
|
+
},
|
|
2087
|
+
{
|
|
2088
|
+
"kind": "code",
|
|
2089
|
+
"text": "`true`"
|
|
2090
|
+
},
|
|
2091
|
+
{
|
|
2092
|
+
"kind": "text",
|
|
2093
|
+
"text": " for these errors\n (the client keeps retrying with exponential backoff). If the error\n becomes non-recoverable, a disconnection with "
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"kind": "code",
|
|
2097
|
+
"text": "`recoverable: false`"
|
|
2098
|
+
},
|
|
2099
|
+
{
|
|
2100
|
+
"kind": "text",
|
|
2101
|
+
"text": "\n is fired instead.\n\nInspect "
|
|
2102
|
+
},
|
|
2103
|
+
{
|
|
2104
|
+
"kind": "code",
|
|
2105
|
+
"text": "`error.recoverable`"
|
|
2106
|
+
},
|
|
2107
|
+
{
|
|
2108
|
+
"kind": "text",
|
|
2109
|
+
"text": " to distinguish transient errors (where\nthe client is auto-reconnecting) from permanent failures (where user\naction is required).\n\nNote: this handler may fire multiple times during a single session.\nFor example, a typical recovery flow looks like:\n"
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
"kind": "code",
|
|
2113
|
+
"text": "`subscribed → error (recoverable) → error (recoverable) → subscribed`"
|
|
2114
|
+
},
|
|
2115
|
+
{
|
|
2116
|
+
"kind": "text",
|
|
2117
|
+
"text": "\nThis happens because the client automatically tries to recover itself\nafter an unexpected disconnection."
|
|
2118
|
+
}
|
|
2119
|
+
],
|
|
2120
|
+
"blockTags": [
|
|
2121
|
+
{
|
|
2122
|
+
"tag": "@param",
|
|
2123
|
+
"name": "error",
|
|
2124
|
+
"content": [
|
|
2125
|
+
{
|
|
2126
|
+
"kind": "text",
|
|
2127
|
+
"text": "The error that occurred, including "
|
|
2128
|
+
},
|
|
2129
|
+
{
|
|
2130
|
+
"kind": "code",
|
|
2131
|
+
"text": "`errorCode`"
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"kind": "text",
|
|
2135
|
+
"text": ",\n "
|
|
2136
|
+
},
|
|
2137
|
+
{
|
|
2138
|
+
"kind": "code",
|
|
2139
|
+
"text": "`recoverable`"
|
|
2140
|
+
},
|
|
2141
|
+
{
|
|
2142
|
+
"kind": "text",
|
|
2143
|
+
"text": ", and optionally "
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
"kind": "code",
|
|
2147
|
+
"text": "`channel`"
|
|
2148
|
+
},
|
|
2149
|
+
{
|
|
2150
|
+
"kind": "text",
|
|
2151
|
+
"text": " and "
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"kind": "code",
|
|
2155
|
+
"text": "`status`"
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
"kind": "text",
|
|
2159
|
+
"text": "."
|
|
2160
|
+
}
|
|
2161
|
+
]
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
"tag": "@param",
|
|
2165
|
+
"name": "subscriptionId",
|
|
2166
|
+
"content": [
|
|
2167
|
+
{
|
|
2168
|
+
"kind": "text",
|
|
2169
|
+
"text": "The ID of the affected subscription."
|
|
2170
|
+
}
|
|
2171
|
+
]
|
|
2172
|
+
}
|
|
2173
|
+
]
|
|
2174
|
+
},
|
|
2175
|
+
"type": {
|
|
2176
|
+
"type": "reference",
|
|
2177
|
+
"target": 56,
|
|
2178
|
+
"name": "SubscriptionErrorHandler",
|
|
2179
|
+
"package": "@wix/realtime-common"
|
|
2180
|
+
}
|
|
2181
|
+
}
|
|
2182
|
+
],
|
|
2183
|
+
"groups": [
|
|
2184
|
+
{
|
|
2185
|
+
"title": "Properties",
|
|
2186
|
+
"children": [
|
|
2187
|
+
67,
|
|
2188
|
+
68
|
|
2189
|
+
]
|
|
2190
|
+
}
|
|
2191
|
+
]
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"id": 69,
|
|
2195
|
+
"name": "UnsubscribeOptions",
|
|
2196
|
+
"variant": "declaration",
|
|
2197
|
+
"kind": 256,
|
|
2198
|
+
"flags": {},
|
|
2199
|
+
"comment": {
|
|
2200
|
+
"summary": [
|
|
2201
|
+
{
|
|
2202
|
+
"kind": "text",
|
|
2203
|
+
"text": "An object containing options to be used when unsubscribing from a\nchannel or channel resource."
|
|
2204
|
+
}
|
|
2205
|
+
]
|
|
2206
|
+
},
|
|
2207
|
+
"children": [
|
|
2208
|
+
{
|
|
2209
|
+
"id": 70,
|
|
2210
|
+
"name": "channel",
|
|
2211
|
+
"variant": "declaration",
|
|
2212
|
+
"kind": 1024,
|
|
2213
|
+
"flags": {
|
|
2214
|
+
"isOptional": true
|
|
2215
|
+
},
|
|
2216
|
+
"comment": {
|
|
2217
|
+
"summary": [
|
|
2218
|
+
{
|
|
2219
|
+
"kind": "text",
|
|
2220
|
+
"text": "The channel, and optionally the resource, to\nunsubscribe from. Use this property when unsubscribing from all subscriptions to a channel\nor channel resource."
|
|
2221
|
+
}
|
|
2222
|
+
]
|
|
2223
|
+
},
|
|
2224
|
+
"type": {
|
|
2225
|
+
"type": "reference",
|
|
2226
|
+
"target": 43,
|
|
2227
|
+
"name": "Channel",
|
|
2228
|
+
"package": "@wix/realtime-common"
|
|
2229
|
+
}
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
"id": 71,
|
|
2233
|
+
"name": "subscriptionId",
|
|
2234
|
+
"variant": "declaration",
|
|
2235
|
+
"kind": 1024,
|
|
2236
|
+
"flags": {
|
|
2237
|
+
"isOptional": true
|
|
2238
|
+
},
|
|
2239
|
+
"comment": {
|
|
2240
|
+
"summary": [
|
|
2241
|
+
{
|
|
2242
|
+
"kind": "text",
|
|
2243
|
+
"text": "ID of the subscription to unsubscribe from. Use this\nproperty when unsubscribing from one of multiple subscriptions to a channel or channel\nresource."
|
|
2244
|
+
}
|
|
2245
|
+
]
|
|
2246
|
+
},
|
|
2247
|
+
"type": {
|
|
2248
|
+
"type": "intrinsic",
|
|
2249
|
+
"name": "string"
|
|
2250
|
+
}
|
|
2251
|
+
}
|
|
2252
|
+
],
|
|
2253
|
+
"groups": [
|
|
2254
|
+
{
|
|
2255
|
+
"title": "Properties",
|
|
2256
|
+
"children": [
|
|
2257
|
+
70,
|
|
2258
|
+
71
|
|
2259
|
+
]
|
|
2260
|
+
}
|
|
2261
|
+
]
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"id": 49,
|
|
2265
|
+
"name": "MessageHandler",
|
|
2266
|
+
"variant": "declaration",
|
|
2267
|
+
"kind": 4194304,
|
|
2268
|
+
"flags": {},
|
|
2269
|
+
"type": {
|
|
2270
|
+
"type": "reflection",
|
|
2271
|
+
"declaration": {
|
|
2272
|
+
"id": 50,
|
|
2273
|
+
"name": "__type",
|
|
2274
|
+
"variant": "declaration",
|
|
2275
|
+
"kind": 65536,
|
|
2276
|
+
"flags": {},
|
|
2277
|
+
"signatures": [
|
|
2278
|
+
{
|
|
2279
|
+
"id": 51,
|
|
2280
|
+
"name": "__type",
|
|
2281
|
+
"variant": "signature",
|
|
2282
|
+
"kind": 4096,
|
|
2283
|
+
"flags": {},
|
|
2284
|
+
"comment": {
|
|
2285
|
+
"summary": [
|
|
2286
|
+
{
|
|
2287
|
+
"kind": "text",
|
|
2288
|
+
"text": "Handles a message published to a channel or channel resource."
|
|
2289
|
+
}
|
|
2290
|
+
]
|
|
2291
|
+
},
|
|
2292
|
+
"parameters": [
|
|
2293
|
+
{
|
|
2294
|
+
"id": 52,
|
|
2295
|
+
"name": "message",
|
|
2296
|
+
"variant": "param",
|
|
2297
|
+
"kind": 32768,
|
|
2298
|
+
"flags": {},
|
|
2299
|
+
"type": {
|
|
2300
|
+
"type": "reference",
|
|
2301
|
+
"target": 46,
|
|
2302
|
+
"name": "Message",
|
|
2303
|
+
"package": "@wix/realtime-common"
|
|
2304
|
+
}
|
|
2305
|
+
},
|
|
2306
|
+
{
|
|
2307
|
+
"id": 53,
|
|
2308
|
+
"name": "channel",
|
|
2309
|
+
"variant": "param",
|
|
2310
|
+
"kind": 32768,
|
|
2311
|
+
"flags": {},
|
|
2312
|
+
"type": {
|
|
2313
|
+
"type": "reference",
|
|
2314
|
+
"target": 43,
|
|
2315
|
+
"name": "Channel",
|
|
2316
|
+
"package": "@wix/realtime-common"
|
|
2317
|
+
}
|
|
2318
|
+
}
|
|
2319
|
+
],
|
|
2320
|
+
"type": {
|
|
2321
|
+
"type": "intrinsic",
|
|
2322
|
+
"name": "void"
|
|
2323
|
+
}
|
|
2324
|
+
}
|
|
2325
|
+
]
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
},
|
|
2329
|
+
{
|
|
2330
|
+
"id": 56,
|
|
2331
|
+
"name": "SubscriptionErrorHandler",
|
|
2332
|
+
"variant": "declaration",
|
|
2333
|
+
"kind": 4194304,
|
|
2334
|
+
"flags": {},
|
|
2335
|
+
"type": {
|
|
2336
|
+
"type": "reflection",
|
|
2337
|
+
"declaration": {
|
|
2338
|
+
"id": 57,
|
|
2339
|
+
"name": "__type",
|
|
2340
|
+
"variant": "declaration",
|
|
2341
|
+
"kind": 65536,
|
|
2342
|
+
"flags": {},
|
|
2343
|
+
"signatures": [
|
|
2344
|
+
{
|
|
2345
|
+
"id": 58,
|
|
2346
|
+
"name": "__type",
|
|
2347
|
+
"variant": "signature",
|
|
2348
|
+
"kind": 4096,
|
|
2349
|
+
"flags": {},
|
|
2350
|
+
"comment": {
|
|
2351
|
+
"summary": [
|
|
2352
|
+
{
|
|
2353
|
+
"kind": "text",
|
|
2354
|
+
"text": "Handles a subscription error event."
|
|
2355
|
+
}
|
|
2356
|
+
]
|
|
2357
|
+
},
|
|
2358
|
+
"parameters": [
|
|
2359
|
+
{
|
|
2360
|
+
"id": 59,
|
|
2361
|
+
"name": "error",
|
|
2362
|
+
"variant": "param",
|
|
2363
|
+
"kind": 32768,
|
|
2364
|
+
"flags": {},
|
|
2365
|
+
"type": {
|
|
2366
|
+
"type": "reference",
|
|
2367
|
+
"target": 72,
|
|
2368
|
+
"name": "RealtimeError",
|
|
2369
|
+
"package": "@wix/realtime-common"
|
|
2370
|
+
}
|
|
2371
|
+
},
|
|
2372
|
+
{
|
|
2373
|
+
"id": 60,
|
|
2374
|
+
"name": "subscriptionId",
|
|
2375
|
+
"variant": "param",
|
|
2376
|
+
"kind": 32768,
|
|
2377
|
+
"flags": {},
|
|
2378
|
+
"type": {
|
|
2379
|
+
"type": "intrinsic",
|
|
2380
|
+
"name": "string"
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
],
|
|
2384
|
+
"type": {
|
|
2385
|
+
"type": "intrinsic",
|
|
2386
|
+
"name": "void"
|
|
2387
|
+
}
|
|
2388
|
+
}
|
|
2389
|
+
]
|
|
2390
|
+
}
|
|
2391
|
+
}
|
|
2392
|
+
},
|
|
2393
|
+
{
|
|
2394
|
+
"id": 61,
|
|
2395
|
+
"name": "SubscriptionHandler",
|
|
2396
|
+
"variant": "declaration",
|
|
2397
|
+
"kind": 4194304,
|
|
2398
|
+
"flags": {},
|
|
2399
|
+
"type": {
|
|
2400
|
+
"type": "reflection",
|
|
2401
|
+
"declaration": {
|
|
2402
|
+
"id": 62,
|
|
2403
|
+
"name": "__type",
|
|
2404
|
+
"variant": "declaration",
|
|
2405
|
+
"kind": 65536,
|
|
2406
|
+
"flags": {},
|
|
2407
|
+
"signatures": [
|
|
2408
|
+
{
|
|
2409
|
+
"id": 63,
|
|
2410
|
+
"name": "__type",
|
|
2411
|
+
"variant": "signature",
|
|
2412
|
+
"kind": 4096,
|
|
2413
|
+
"flags": {},
|
|
2414
|
+
"comment": {
|
|
2415
|
+
"summary": [
|
|
2416
|
+
{
|
|
2417
|
+
"kind": "text",
|
|
2418
|
+
"text": "Handles a successful subscription or re-subscription event."
|
|
2419
|
+
}
|
|
2420
|
+
]
|
|
2421
|
+
},
|
|
2422
|
+
"parameters": [
|
|
2423
|
+
{
|
|
2424
|
+
"id": 64,
|
|
2425
|
+
"name": "subscriptionId",
|
|
2426
|
+
"variant": "param",
|
|
2427
|
+
"kind": 32768,
|
|
2428
|
+
"flags": {},
|
|
2429
|
+
"type": {
|
|
2430
|
+
"type": "intrinsic",
|
|
2431
|
+
"name": "string"
|
|
2432
|
+
}
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
"id": 65,
|
|
2436
|
+
"name": "isSynced",
|
|
2437
|
+
"variant": "param",
|
|
2438
|
+
"kind": 32768,
|
|
2439
|
+
"flags": {},
|
|
2440
|
+
"type": {
|
|
2441
|
+
"type": "intrinsic",
|
|
2442
|
+
"name": "boolean"
|
|
2443
|
+
}
|
|
2444
|
+
}
|
|
2445
|
+
],
|
|
2446
|
+
"type": {
|
|
2447
|
+
"type": "intrinsic",
|
|
2448
|
+
"name": "void"
|
|
2449
|
+
}
|
|
2450
|
+
}
|
|
2451
|
+
]
|
|
2452
|
+
}
|
|
2453
|
+
}
|
|
2454
|
+
}
|
|
2455
|
+
],
|
|
2456
|
+
"groups": [
|
|
2457
|
+
{
|
|
2458
|
+
"title": "Namespaces",
|
|
2459
|
+
"children": [
|
|
2460
|
+
23,
|
|
2461
|
+
1,
|
|
2462
|
+
30
|
|
2463
|
+
]
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
"title": "Enumerations",
|
|
2467
|
+
"children": [
|
|
2468
|
+
86
|
|
2469
|
+
]
|
|
2470
|
+
},
|
|
2471
|
+
{
|
|
2472
|
+
"title": "Classes",
|
|
2473
|
+
"children": [
|
|
2474
|
+
72
|
|
2475
|
+
]
|
|
2476
|
+
},
|
|
2477
|
+
{
|
|
2478
|
+
"title": "Interfaces",
|
|
2479
|
+
"children": [
|
|
2480
|
+
43,
|
|
2481
|
+
46,
|
|
2482
|
+
54,
|
|
2483
|
+
66,
|
|
2484
|
+
69
|
|
2485
|
+
]
|
|
2486
|
+
},
|
|
2487
|
+
{
|
|
2488
|
+
"title": "Type Aliases",
|
|
2489
|
+
"children": [
|
|
2490
|
+
49,
|
|
2491
|
+
56,
|
|
2492
|
+
61
|
|
1127
2493
|
]
|
|
1128
2494
|
}
|
|
1129
2495
|
],
|