@wix/realtime 1.0.69 → 1.0.71
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/dist/statics/docs-ts-model.json +841 -1238
- package/package.json +5 -5
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"typeDocModel": {
|
|
3
|
+
"schemaVersion": "2.0",
|
|
3
4
|
"id": 0,
|
|
4
5
|
"name": "@wix/realtime",
|
|
5
6
|
"variant": "project",
|
|
@@ -7,14 +8,14 @@
|
|
|
7
8
|
"flags": {},
|
|
8
9
|
"children": [
|
|
9
10
|
{
|
|
10
|
-
"id":
|
|
11
|
+
"id": 12,
|
|
11
12
|
"name": "publisher",
|
|
12
13
|
"variant": "declaration",
|
|
13
14
|
"kind": 4,
|
|
14
15
|
"flags": {},
|
|
15
16
|
"children": [
|
|
16
17
|
{
|
|
17
|
-
"id":
|
|
18
|
+
"id": 57,
|
|
18
19
|
"name": "PublishChannel",
|
|
19
20
|
"variant": "declaration",
|
|
20
21
|
"kind": 256,
|
|
@@ -29,7 +30,7 @@
|
|
|
29
30
|
},
|
|
30
31
|
"children": [
|
|
31
32
|
{
|
|
32
|
-
"id":
|
|
33
|
+
"id": 58,
|
|
33
34
|
"name": "name",
|
|
34
35
|
"variant": "declaration",
|
|
35
36
|
"kind": 1024,
|
|
@@ -64,7 +65,7 @@
|
|
|
64
65
|
}
|
|
65
66
|
},
|
|
66
67
|
{
|
|
67
|
-
"id":
|
|
68
|
+
"id": 59,
|
|
68
69
|
"name": "resourceId",
|
|
69
70
|
"variant": "declaration",
|
|
70
71
|
"kind": 1024,
|
|
@@ -89,308 +90,188 @@
|
|
|
89
90
|
{
|
|
90
91
|
"title": "Properties",
|
|
91
92
|
"children": [
|
|
92
|
-
|
|
93
|
-
|
|
93
|
+
58,
|
|
94
|
+
59
|
|
94
95
|
]
|
|
95
96
|
}
|
|
96
97
|
]
|
|
97
98
|
},
|
|
98
99
|
{
|
|
99
|
-
"id":
|
|
100
|
+
"id": 13,
|
|
100
101
|
"name": "publish",
|
|
101
102
|
"variant": "declaration",
|
|
102
|
-
"kind":
|
|
103
|
-
"flags": {
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
103
|
+
"kind": 32,
|
|
104
|
+
"flags": {
|
|
105
|
+
"isConst": true
|
|
106
|
+
},
|
|
107
|
+
"comment": {
|
|
108
|
+
"summary": [
|
|
109
|
+
{
|
|
110
|
+
"kind": "text",
|
|
111
|
+
"text": "Publishes a message to a channel or resource.\n\nThe method publishes a message to all subscribers on the specified channel or resource. Channels and resources are independent, so subscribers to a channel don't receive messages sent to a resource on that channel. Similarly, subscribers to a resource don't receive messages sent to its parent channel.\n\n> **Authentication**\n>\n> This method may require higher-level permissions than the caller has, based on their [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) and [roles and permissions](https://support.wix.com/en/article/roles-permissions-overview). In these cases, you can ensure the method is called with the required level of authorization by using [elevated permissions](https://dev.wix.com/docs/api-reference/articles/authentication/about-elevated-permissions).\n\n<!-- TODO: Check whether this API is relevant for headless projects. -->"
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"blockTags": [
|
|
115
|
+
{
|
|
116
|
+
"tag": "@example",
|
|
117
|
+
"name": "Publish a message to the specified channel",
|
|
118
|
+
"content": [
|
|
113
119
|
{
|
|
114
|
-
"kind": "
|
|
115
|
-
"text": "
|
|
120
|
+
"kind": "code",
|
|
121
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nconst elevatedPublish = elevate(publisher.publish);\nawait elevatedPublish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
116
122
|
}
|
|
117
|
-
]
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
"kind": "text",
|
|
124
|
-
"text": "Publish a message to the specified channel\n"
|
|
125
|
-
},
|
|
126
|
-
{
|
|
127
|
-
"kind": "code",
|
|
128
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nconst elevatedPublish = elevate(publisher.publish);\nawait elevatedPublish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
129
|
-
}
|
|
130
|
-
]
|
|
131
|
-
},
|
|
132
|
-
{
|
|
133
|
-
"tag": "@example",
|
|
134
|
-
"content": [
|
|
135
|
-
{
|
|
136
|
-
"kind": "text",
|
|
137
|
-
"text": "Publish a message to the specified channel: Self-hosted\n"
|
|
138
|
-
},
|
|
139
|
-
{
|
|
140
|
-
"kind": "code",
|
|
141
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { publisher },\n // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
142
|
-
}
|
|
143
|
-
]
|
|
144
|
-
},
|
|
145
|
-
{
|
|
146
|
-
"tag": "@requiredField",
|
|
147
|
-
"content": [
|
|
148
|
-
{
|
|
149
|
-
"kind": "text",
|
|
150
|
-
"text": "channel"
|
|
151
|
-
}
|
|
152
|
-
]
|
|
153
|
-
},
|
|
154
|
-
{
|
|
155
|
-
"tag": "@requiredField",
|
|
156
|
-
"content": [
|
|
157
|
-
{
|
|
158
|
-
"kind": "text",
|
|
159
|
-
"text": "payload"
|
|
160
|
-
}
|
|
161
|
-
]
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
"tag": "@permissionScope",
|
|
165
|
-
"content": [
|
|
166
|
-
{
|
|
167
|
-
"kind": "text",
|
|
168
|
-
"text": "Publish Realtime Messages"
|
|
169
|
-
}
|
|
170
|
-
]
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"tag": "@permissionScopeId",
|
|
174
|
-
"content": [
|
|
175
|
-
{
|
|
176
|
-
"kind": "text",
|
|
177
|
-
"text": "SCOPE.API_INFRA.REALTIME_PUBLISH"
|
|
178
|
-
}
|
|
179
|
-
]
|
|
180
|
-
},
|
|
123
|
+
]
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
"tag": "@example",
|
|
127
|
+
"name": "Publish a message to the specified channel: Self-hosted",
|
|
128
|
+
"content": [
|
|
181
129
|
{
|
|
182
|
-
"
|
|
183
|
-
"
|
|
184
|
-
{
|
|
185
|
-
"kind": "text",
|
|
186
|
-
"text": "com.wix.realtime.v4.DuplexerApiV4.Publish"
|
|
187
|
-
}
|
|
188
|
-
]
|
|
130
|
+
"kind": "code",
|
|
131
|
+
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { publisher },\n // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
189
132
|
}
|
|
190
133
|
]
|
|
191
134
|
},
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
"variant": "param",
|
|
197
|
-
"kind": 32768,
|
|
198
|
-
"flags": {},
|
|
199
|
-
"comment": {
|
|
200
|
-
"summary": [
|
|
201
|
-
{
|
|
202
|
-
"kind": "text",
|
|
203
|
-
"text": "Channel and resource to publish to."
|
|
204
|
-
}
|
|
205
|
-
]
|
|
206
|
-
},
|
|
207
|
-
"type": {
|
|
208
|
-
"type": "reference",
|
|
209
|
-
"target": 53,
|
|
210
|
-
"name": "PublishChannel",
|
|
211
|
-
"package": "@wix/realtime-common"
|
|
212
|
-
}
|
|
213
|
-
},
|
|
214
|
-
{
|
|
215
|
-
"id": 59,
|
|
216
|
-
"name": "payload",
|
|
217
|
-
"variant": "param",
|
|
218
|
-
"kind": 32768,
|
|
219
|
-
"flags": {},
|
|
220
|
-
"comment": {
|
|
221
|
-
"summary": [
|
|
222
|
-
{
|
|
223
|
-
"kind": "text",
|
|
224
|
-
"text": "Message payload. Max: 10 KB."
|
|
225
|
-
}
|
|
226
|
-
]
|
|
227
|
-
},
|
|
228
|
-
"type": {
|
|
229
|
-
"type": "reference",
|
|
230
|
-
"target": {
|
|
231
|
-
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
232
|
-
"qualifiedName": "Record"
|
|
233
|
-
},
|
|
234
|
-
"typeArguments": [
|
|
235
|
-
{
|
|
236
|
-
"type": "intrinsic",
|
|
237
|
-
"name": "string"
|
|
238
|
-
},
|
|
239
|
-
{
|
|
240
|
-
"type": "intrinsic",
|
|
241
|
-
"name": "any"
|
|
242
|
-
}
|
|
243
|
-
],
|
|
244
|
-
"name": "Record",
|
|
245
|
-
"package": "typescript"
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
|
-
],
|
|
249
|
-
"type": {
|
|
250
|
-
"type": "reference",
|
|
251
|
-
"target": {
|
|
252
|
-
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
253
|
-
"qualifiedName": "Promise"
|
|
254
|
-
},
|
|
255
|
-
"typeArguments": [
|
|
135
|
+
{
|
|
136
|
+
"tag": "@param",
|
|
137
|
+
"name": "channel",
|
|
138
|
+
"content": [
|
|
256
139
|
{
|
|
257
|
-
"
|
|
258
|
-
"
|
|
140
|
+
"kind": "text",
|
|
141
|
+
"text": "Channel and resource to publish to."
|
|
259
142
|
}
|
|
260
|
-
]
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
{
|
|
266
|
-
"id": 60,
|
|
267
|
-
"name": "publish",
|
|
268
|
-
"variant": "signature",
|
|
269
|
-
"kind": 4096,
|
|
270
|
-
"flags": {},
|
|
271
|
-
"comment": {
|
|
272
|
-
"summary": [
|
|
143
|
+
]
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"tag": "@requiredField",
|
|
147
|
+
"content": [
|
|
273
148
|
{
|
|
274
149
|
"kind": "text",
|
|
275
|
-
"text": "
|
|
150
|
+
"text": "channel"
|
|
276
151
|
}
|
|
277
|
-
]
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
"kind": "text",
|
|
284
|
-
"text": "Publish a message to the specified channel\n"
|
|
285
|
-
},
|
|
286
|
-
{
|
|
287
|
-
"kind": "code",
|
|
288
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nconst elevatedPublish = elevate(publisher.publish);\nawait elevatedPublish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
289
|
-
}
|
|
290
|
-
]
|
|
291
|
-
},
|
|
292
|
-
{
|
|
293
|
-
"tag": "@example",
|
|
294
|
-
"content": [
|
|
295
|
-
{
|
|
296
|
-
"kind": "text",
|
|
297
|
-
"text": "Publish a message to the specified channel: Self-hosted\n"
|
|
298
|
-
},
|
|
299
|
-
{
|
|
300
|
-
"kind": "code",
|
|
301
|
-
"text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { publisher },\n // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });\n```"
|
|
302
|
-
}
|
|
303
|
-
]
|
|
304
|
-
},
|
|
305
|
-
{
|
|
306
|
-
"tag": "@requiredField",
|
|
307
|
-
"content": [
|
|
308
|
-
{
|
|
309
|
-
"kind": "text",
|
|
310
|
-
"text": "channel"
|
|
311
|
-
}
|
|
312
|
-
]
|
|
313
|
-
},
|
|
152
|
+
]
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"tag": "@param",
|
|
156
|
+
"name": "payload",
|
|
157
|
+
"content": [
|
|
314
158
|
{
|
|
315
|
-
"
|
|
316
|
-
"
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
159
|
+
"kind": "text",
|
|
160
|
+
"text": "Message payload. Max: 10 KB."
|
|
161
|
+
}
|
|
162
|
+
]
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"tag": "@requiredField",
|
|
166
|
+
"content": [
|
|
323
167
|
{
|
|
324
|
-
"
|
|
325
|
-
"
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
168
|
+
"kind": "text",
|
|
169
|
+
"text": "payload"
|
|
170
|
+
}
|
|
171
|
+
]
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"tag": "@permissionScope",
|
|
175
|
+
"content": [
|
|
332
176
|
{
|
|
333
|
-
"
|
|
334
|
-
"
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
177
|
+
"kind": "text",
|
|
178
|
+
"text": "Publish Realtime Messages"
|
|
179
|
+
}
|
|
180
|
+
]
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"tag": "@permissionScopeId",
|
|
184
|
+
"content": [
|
|
341
185
|
{
|
|
342
|
-
"
|
|
343
|
-
"
|
|
344
|
-
{
|
|
345
|
-
"kind": "text",
|
|
346
|
-
"text": "com.wix.realtime.v4.DuplexerApiV4.Publish"
|
|
347
|
-
}
|
|
348
|
-
]
|
|
186
|
+
"kind": "text",
|
|
187
|
+
"text": "SCOPE.API_INFRA.REALTIME_PUBLISH"
|
|
349
188
|
}
|
|
350
189
|
]
|
|
351
190
|
},
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
191
|
+
{
|
|
192
|
+
"tag": "@fqn",
|
|
193
|
+
"content": [
|
|
194
|
+
{
|
|
195
|
+
"kind": "text",
|
|
196
|
+
"text": "com.wix.realtime.v4.DuplexerApiV4.Publish"
|
|
197
|
+
}
|
|
198
|
+
]
|
|
199
|
+
}
|
|
200
|
+
]
|
|
201
|
+
},
|
|
202
|
+
"type": {
|
|
203
|
+
"type": "reference",
|
|
204
|
+
"target": {
|
|
205
|
+
"packageName": "@wix/sdk-types",
|
|
206
|
+
"packagePath": "build/index.d.ts",
|
|
207
|
+
"qualifiedName": "MaybeContext"
|
|
208
|
+
},
|
|
209
|
+
"typeArguments": [
|
|
210
|
+
{
|
|
211
|
+
"type": "intersection",
|
|
212
|
+
"types": [
|
|
213
|
+
{
|
|
360
214
|
"type": "reference",
|
|
361
215
|
"target": {
|
|
362
|
-
"
|
|
363
|
-
"
|
|
216
|
+
"packageName": "@wix/sdk-types",
|
|
217
|
+
"packagePath": "build/index.d.ts",
|
|
218
|
+
"qualifiedName": "BuildRESTFunction"
|
|
364
219
|
},
|
|
365
|
-
"
|
|
220
|
+
"typeArguments": [
|
|
221
|
+
{
|
|
222
|
+
"type": "query",
|
|
223
|
+
"queryType": {
|
|
224
|
+
"type": "reference",
|
|
225
|
+
"target": {
|
|
226
|
+
"packageName": "@wix/realtime",
|
|
227
|
+
"packagePath": "src/publisher/publisher.public.ts",
|
|
228
|
+
"qualifiedName": "publish"
|
|
229
|
+
},
|
|
230
|
+
"name": "publicPublish",
|
|
231
|
+
"package": "@wix/realtime",
|
|
232
|
+
"qualifiedName": "publish",
|
|
233
|
+
"preferValues": true
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
],
|
|
237
|
+
"name": "BuildRESTFunction",
|
|
366
238
|
"package": "@wix/sdk-types"
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"type": "query",
|
|
242
|
+
"queryType": {
|
|
243
|
+
"type": "reference",
|
|
244
|
+
"target": {
|
|
245
|
+
"packageName": "@wix/realtime",
|
|
246
|
+
"packagePath": "src/publisher/publisher.public.ts",
|
|
247
|
+
"qualifiedName": "publish"
|
|
248
|
+
},
|
|
249
|
+
"name": "publicPublish",
|
|
250
|
+
"package": "@wix/realtime",
|
|
251
|
+
"qualifiedName": "publish",
|
|
252
|
+
"preferValues": true
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
]
|
|
378
256
|
}
|
|
379
|
-
|
|
380
|
-
|
|
257
|
+
],
|
|
258
|
+
"name": "MaybeContext",
|
|
259
|
+
"package": "@wix/sdk-types"
|
|
260
|
+
},
|
|
261
|
+
"defaultValue": "..."
|
|
381
262
|
}
|
|
382
263
|
],
|
|
383
264
|
"groups": [
|
|
384
265
|
{
|
|
385
266
|
"title": "Interfaces",
|
|
386
267
|
"children": [
|
|
387
|
-
|
|
268
|
+
57
|
|
388
269
|
]
|
|
389
270
|
},
|
|
390
271
|
{
|
|
391
|
-
"title": "
|
|
272
|
+
"title": "Variables",
|
|
392
273
|
"children": [
|
|
393
|
-
|
|
274
|
+
13
|
|
394
275
|
]
|
|
395
276
|
}
|
|
396
277
|
]
|
|
@@ -403,14 +284,14 @@
|
|
|
403
284
|
"flags": {},
|
|
404
285
|
"children": [
|
|
405
286
|
{
|
|
406
|
-
"id":
|
|
287
|
+
"id": 17,
|
|
407
288
|
"name": "PermissionsRouter",
|
|
408
289
|
"variant": "declaration",
|
|
409
290
|
"kind": 4,
|
|
410
291
|
"flags": {},
|
|
411
292
|
"children": [
|
|
412
293
|
{
|
|
413
|
-
"id":
|
|
294
|
+
"id": 29,
|
|
414
295
|
"name": "PermissionsRouter",
|
|
415
296
|
"variant": "declaration",
|
|
416
297
|
"kind": 256,
|
|
@@ -425,14 +306,14 @@
|
|
|
425
306
|
},
|
|
426
307
|
"children": [
|
|
427
308
|
{
|
|
428
|
-
"id":
|
|
309
|
+
"id": 30,
|
|
429
310
|
"name": "add",
|
|
430
311
|
"variant": "declaration",
|
|
431
312
|
"kind": 2048,
|
|
432
313
|
"flags": {},
|
|
433
314
|
"signatures": [
|
|
434
315
|
{
|
|
435
|
-
"id":
|
|
316
|
+
"id": 31,
|
|
436
317
|
"name": "add",
|
|
437
318
|
"variant": "signature",
|
|
438
319
|
"kind": 4096,
|
|
@@ -485,7 +366,7 @@
|
|
|
485
366
|
},
|
|
486
367
|
"parameters": [
|
|
487
368
|
{
|
|
488
|
-
"id":
|
|
369
|
+
"id": 32,
|
|
489
370
|
"name": "channel",
|
|
490
371
|
"variant": "param",
|
|
491
372
|
"kind": 32768,
|
|
@@ -500,13 +381,13 @@
|
|
|
500
381
|
},
|
|
501
382
|
"type": {
|
|
502
383
|
"type": "reference",
|
|
503
|
-
"target":
|
|
384
|
+
"target": 46,
|
|
504
385
|
"name": "Channel",
|
|
505
386
|
"package": "@wix/realtime-common"
|
|
506
387
|
}
|
|
507
388
|
},
|
|
508
389
|
{
|
|
509
|
-
"id":
|
|
390
|
+
"id": 33,
|
|
510
391
|
"name": "handler",
|
|
511
392
|
"variant": "param",
|
|
512
393
|
"kind": 32768,
|
|
@@ -521,7 +402,7 @@
|
|
|
521
402
|
},
|
|
522
403
|
"type": {
|
|
523
404
|
"type": "reference",
|
|
524
|
-
"target":
|
|
405
|
+
"target": 41,
|
|
525
406
|
"name": "PermissionsHandler",
|
|
526
407
|
"package": "@wix/sdk_realtime_site"
|
|
527
408
|
}
|
|
@@ -533,7 +414,8 @@
|
|
|
533
414
|
{
|
|
534
415
|
"type": "reference",
|
|
535
416
|
"target": {
|
|
536
|
-
"
|
|
417
|
+
"packageName": "typescript",
|
|
418
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
537
419
|
"qualifiedName": "Promise"
|
|
538
420
|
},
|
|
539
421
|
"typeArguments": [
|
|
@@ -555,14 +437,14 @@
|
|
|
555
437
|
]
|
|
556
438
|
},
|
|
557
439
|
{
|
|
558
|
-
"id":
|
|
440
|
+
"id": 34,
|
|
559
441
|
"name": "check",
|
|
560
442
|
"variant": "declaration",
|
|
561
443
|
"kind": 2048,
|
|
562
444
|
"flags": {},
|
|
563
445
|
"signatures": [
|
|
564
446
|
{
|
|
565
|
-
"id":
|
|
447
|
+
"id": 35,
|
|
566
448
|
"name": "check",
|
|
567
449
|
"variant": "signature",
|
|
568
450
|
"kind": 4096,
|
|
@@ -641,7 +523,7 @@
|
|
|
641
523
|
},
|
|
642
524
|
"parameters": [
|
|
643
525
|
{
|
|
644
|
-
"id":
|
|
526
|
+
"id": 36,
|
|
645
527
|
"name": "channel",
|
|
646
528
|
"variant": "param",
|
|
647
529
|
"kind": 32768,
|
|
@@ -656,13 +538,13 @@
|
|
|
656
538
|
},
|
|
657
539
|
"type": {
|
|
658
540
|
"type": "reference",
|
|
659
|
-
"target":
|
|
541
|
+
"target": 46,
|
|
660
542
|
"name": "Channel",
|
|
661
543
|
"package": "@wix/realtime-common"
|
|
662
544
|
}
|
|
663
545
|
},
|
|
664
546
|
{
|
|
665
|
-
"id":
|
|
547
|
+
"id": 37,
|
|
666
548
|
"name": "subscriber",
|
|
667
549
|
"variant": "param",
|
|
668
550
|
"kind": 32768,
|
|
@@ -677,7 +559,7 @@
|
|
|
677
559
|
},
|
|
678
560
|
"type": {
|
|
679
561
|
"type": "reference",
|
|
680
|
-
"target":
|
|
562
|
+
"target": 51,
|
|
681
563
|
"name": "Subscriber",
|
|
682
564
|
"package": "@wix/realtime-common"
|
|
683
565
|
}
|
|
@@ -689,13 +571,14 @@
|
|
|
689
571
|
{
|
|
690
572
|
"type": "reference",
|
|
691
573
|
"target": {
|
|
692
|
-
"
|
|
574
|
+
"packageName": "typescript",
|
|
575
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
693
576
|
"qualifiedName": "Promise"
|
|
694
577
|
},
|
|
695
578
|
"typeArguments": [
|
|
696
579
|
{
|
|
697
580
|
"type": "reference",
|
|
698
|
-
"target":
|
|
581
|
+
"target": 49,
|
|
699
582
|
"name": "ChannelPermissions",
|
|
700
583
|
"package": "@wix/realtime-common"
|
|
701
584
|
}
|
|
@@ -705,7 +588,7 @@
|
|
|
705
588
|
},
|
|
706
589
|
{
|
|
707
590
|
"type": "reference",
|
|
708
|
-
"target":
|
|
591
|
+
"target": 49,
|
|
709
592
|
"name": "ChannelPermissions",
|
|
710
593
|
"package": "@wix/realtime-common"
|
|
711
594
|
}
|
|
@@ -715,14 +598,14 @@
|
|
|
715
598
|
]
|
|
716
599
|
},
|
|
717
600
|
{
|
|
718
|
-
"id":
|
|
601
|
+
"id": 38,
|
|
719
602
|
"name": "default",
|
|
720
603
|
"variant": "declaration",
|
|
721
604
|
"kind": 2048,
|
|
722
605
|
"flags": {},
|
|
723
606
|
"signatures": [
|
|
724
607
|
{
|
|
725
|
-
"id":
|
|
608
|
+
"id": 39,
|
|
726
609
|
"name": "default",
|
|
727
610
|
"variant": "signature",
|
|
728
611
|
"kind": 4096,
|
|
@@ -757,7 +640,7 @@
|
|
|
757
640
|
},
|
|
758
641
|
"parameters": [
|
|
759
642
|
{
|
|
760
|
-
"id":
|
|
643
|
+
"id": 40,
|
|
761
644
|
"name": "handler",
|
|
762
645
|
"variant": "param",
|
|
763
646
|
"kind": 32768,
|
|
@@ -772,7 +655,7 @@
|
|
|
772
655
|
},
|
|
773
656
|
"type": {
|
|
774
657
|
"type": "reference",
|
|
775
|
-
"target":
|
|
658
|
+
"target": 41,
|
|
776
659
|
"name": "PermissionsHandler",
|
|
777
660
|
"package": "@wix/sdk_realtime_site"
|
|
778
661
|
}
|
|
@@ -790,100 +673,100 @@
|
|
|
790
673
|
{
|
|
791
674
|
"title": "Methods",
|
|
792
675
|
"children": [
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
676
|
+
30,
|
|
677
|
+
34,
|
|
678
|
+
38
|
|
796
679
|
]
|
|
797
680
|
}
|
|
798
681
|
]
|
|
799
682
|
},
|
|
800
683
|
{
|
|
801
|
-
"id":
|
|
684
|
+
"id": 41,
|
|
802
685
|
"name": "PermissionsHandler",
|
|
803
686
|
"variant": "declaration",
|
|
804
|
-
"kind":
|
|
687
|
+
"kind": 2097152,
|
|
805
688
|
"flags": {},
|
|
689
|
+
"comment": {
|
|
690
|
+
"summary": [
|
|
691
|
+
{
|
|
692
|
+
"kind": "text",
|
|
693
|
+
"text": "Determines the permissions for a subscriber on a channel or resource. Return a "
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
"kind": "code",
|
|
697
|
+
"text": "`ChannelPermissions`"
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"kind": "text",
|
|
701
|
+
"text": " object to grant or deny access."
|
|
702
|
+
}
|
|
703
|
+
],
|
|
704
|
+
"blockTags": [
|
|
705
|
+
{
|
|
706
|
+
"tag": "@requiredField",
|
|
707
|
+
"content": [
|
|
708
|
+
{
|
|
709
|
+
"kind": "text",
|
|
710
|
+
"text": "channel"
|
|
711
|
+
}
|
|
712
|
+
]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"tag": "@servicePath",
|
|
716
|
+
"content": [
|
|
717
|
+
{
|
|
718
|
+
"kind": "text",
|
|
719
|
+
"text": "wix-realtime-backend.Channel"
|
|
720
|
+
}
|
|
721
|
+
]
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"tag": "@requiredField",
|
|
725
|
+
"content": [
|
|
726
|
+
{
|
|
727
|
+
"kind": "text",
|
|
728
|
+
"text": "subscriber"
|
|
729
|
+
}
|
|
730
|
+
]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"tag": "@servicePath",
|
|
734
|
+
"content": [
|
|
735
|
+
{
|
|
736
|
+
"kind": "text",
|
|
737
|
+
"text": "wix-realtime-backend.Subscriber"
|
|
738
|
+
}
|
|
739
|
+
]
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
"tag": "@servicePath",
|
|
743
|
+
"content": [
|
|
744
|
+
{
|
|
745
|
+
"kind": "text",
|
|
746
|
+
"text": "wix-realtime-backend.ChannelPermissions"
|
|
747
|
+
}
|
|
748
|
+
]
|
|
749
|
+
}
|
|
750
|
+
]
|
|
751
|
+
},
|
|
806
752
|
"type": {
|
|
807
753
|
"type": "reflection",
|
|
808
754
|
"declaration": {
|
|
809
|
-
"id":
|
|
755
|
+
"id": 42,
|
|
810
756
|
"name": "__type",
|
|
811
757
|
"variant": "declaration",
|
|
812
758
|
"kind": 65536,
|
|
813
759
|
"flags": {},
|
|
814
760
|
"signatures": [
|
|
815
761
|
{
|
|
816
|
-
"id":
|
|
762
|
+
"id": 43,
|
|
817
763
|
"name": "__type",
|
|
818
764
|
"variant": "signature",
|
|
819
765
|
"kind": 4096,
|
|
820
766
|
"flags": {},
|
|
821
|
-
"comment": {
|
|
822
|
-
"summary": [
|
|
823
|
-
{
|
|
824
|
-
"kind": "text",
|
|
825
|
-
"text": "Determines the permissions for a subscriber on a channel or resource. Return a "
|
|
826
|
-
},
|
|
827
|
-
{
|
|
828
|
-
"kind": "code",
|
|
829
|
-
"text": "`ChannelPermissions`"
|
|
830
|
-
},
|
|
831
|
-
{
|
|
832
|
-
"kind": "text",
|
|
833
|
-
"text": " object to grant or deny access."
|
|
834
|
-
}
|
|
835
|
-
],
|
|
836
|
-
"blockTags": [
|
|
837
|
-
{
|
|
838
|
-
"tag": "@requiredField",
|
|
839
|
-
"content": [
|
|
840
|
-
{
|
|
841
|
-
"kind": "text",
|
|
842
|
-
"text": "channel"
|
|
843
|
-
}
|
|
844
|
-
]
|
|
845
|
-
},
|
|
846
|
-
{
|
|
847
|
-
"tag": "@servicePath",
|
|
848
|
-
"content": [
|
|
849
|
-
{
|
|
850
|
-
"kind": "text",
|
|
851
|
-
"text": "wix-realtime-backend.Channel"
|
|
852
|
-
}
|
|
853
|
-
]
|
|
854
|
-
},
|
|
855
|
-
{
|
|
856
|
-
"tag": "@requiredField",
|
|
857
|
-
"content": [
|
|
858
|
-
{
|
|
859
|
-
"kind": "text",
|
|
860
|
-
"text": "subscriber"
|
|
861
|
-
}
|
|
862
|
-
]
|
|
863
|
-
},
|
|
864
|
-
{
|
|
865
|
-
"tag": "@servicePath",
|
|
866
|
-
"content": [
|
|
867
|
-
{
|
|
868
|
-
"kind": "text",
|
|
869
|
-
"text": "wix-realtime-backend.Subscriber"
|
|
870
|
-
}
|
|
871
|
-
]
|
|
872
|
-
},
|
|
873
|
-
{
|
|
874
|
-
"tag": "@servicePath",
|
|
875
|
-
"content": [
|
|
876
|
-
{
|
|
877
|
-
"kind": "text",
|
|
878
|
-
"text": "wix-realtime-backend.ChannelPermissions"
|
|
879
|
-
}
|
|
880
|
-
]
|
|
881
|
-
}
|
|
882
|
-
]
|
|
883
|
-
},
|
|
884
767
|
"parameters": [
|
|
885
768
|
{
|
|
886
|
-
"id":
|
|
769
|
+
"id": 44,
|
|
887
770
|
"name": "channel",
|
|
888
771
|
"variant": "param",
|
|
889
772
|
"kind": 32768,
|
|
@@ -898,13 +781,13 @@
|
|
|
898
781
|
},
|
|
899
782
|
"type": {
|
|
900
783
|
"type": "reference",
|
|
901
|
-
"target":
|
|
784
|
+
"target": 46,
|
|
902
785
|
"name": "Channel",
|
|
903
786
|
"package": "@wix/realtime-common"
|
|
904
787
|
}
|
|
905
788
|
},
|
|
906
789
|
{
|
|
907
|
-
"id":
|
|
790
|
+
"id": 45,
|
|
908
791
|
"name": "subscriber",
|
|
909
792
|
"variant": "param",
|
|
910
793
|
"kind": 32768,
|
|
@@ -919,7 +802,7 @@
|
|
|
919
802
|
},
|
|
920
803
|
"type": {
|
|
921
804
|
"type": "reference",
|
|
922
|
-
"target":
|
|
805
|
+
"target": 51,
|
|
923
806
|
"name": "Subscriber",
|
|
924
807
|
"package": "@wix/realtime-common"
|
|
925
808
|
}
|
|
@@ -931,13 +814,14 @@
|
|
|
931
814
|
{
|
|
932
815
|
"type": "reference",
|
|
933
816
|
"target": {
|
|
934
|
-
"
|
|
817
|
+
"packageName": "typescript",
|
|
818
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
935
819
|
"qualifiedName": "Promise"
|
|
936
820
|
},
|
|
937
821
|
"typeArguments": [
|
|
938
822
|
{
|
|
939
823
|
"type": "reference",
|
|
940
|
-
"target":
|
|
824
|
+
"target": 49,
|
|
941
825
|
"name": "ChannelPermissions",
|
|
942
826
|
"package": "@wix/realtime-common"
|
|
943
827
|
}
|
|
@@ -947,7 +831,7 @@
|
|
|
947
831
|
},
|
|
948
832
|
{
|
|
949
833
|
"type": "reference",
|
|
950
|
-
"target":
|
|
834
|
+
"target": 49,
|
|
951
835
|
"name": "ChannelPermissions",
|
|
952
836
|
"package": "@wix/realtime-common"
|
|
953
837
|
}
|
|
@@ -959,14 +843,14 @@
|
|
|
959
843
|
}
|
|
960
844
|
},
|
|
961
845
|
{
|
|
962
|
-
"id":
|
|
846
|
+
"id": 18,
|
|
963
847
|
"name": "add",
|
|
964
848
|
"variant": "declaration",
|
|
965
849
|
"kind": 64,
|
|
966
850
|
"flags": {},
|
|
967
851
|
"signatures": [
|
|
968
852
|
{
|
|
969
|
-
"id":
|
|
853
|
+
"id": 19,
|
|
970
854
|
"name": "add",
|
|
971
855
|
"variant": "signature",
|
|
972
856
|
"kind": 4096,
|
|
@@ -1019,7 +903,7 @@
|
|
|
1019
903
|
},
|
|
1020
904
|
"parameters": [
|
|
1021
905
|
{
|
|
1022
|
-
"id":
|
|
906
|
+
"id": 20,
|
|
1023
907
|
"name": "channel",
|
|
1024
908
|
"variant": "param",
|
|
1025
909
|
"kind": 32768,
|
|
@@ -1034,13 +918,13 @@
|
|
|
1034
918
|
},
|
|
1035
919
|
"type": {
|
|
1036
920
|
"type": "reference",
|
|
1037
|
-
"target":
|
|
921
|
+
"target": 46,
|
|
1038
922
|
"name": "Channel",
|
|
1039
923
|
"package": "@wix/realtime-common"
|
|
1040
924
|
}
|
|
1041
925
|
},
|
|
1042
926
|
{
|
|
1043
|
-
"id":
|
|
927
|
+
"id": 21,
|
|
1044
928
|
"name": "handler",
|
|
1045
929
|
"variant": "param",
|
|
1046
930
|
"kind": 32768,
|
|
@@ -1055,7 +939,7 @@
|
|
|
1055
939
|
},
|
|
1056
940
|
"type": {
|
|
1057
941
|
"type": "reference",
|
|
1058
|
-
"target":
|
|
942
|
+
"target": 41,
|
|
1059
943
|
"name": "PermissionsHandler",
|
|
1060
944
|
"package": "@wix/sdk_realtime_site"
|
|
1061
945
|
}
|
|
@@ -1064,7 +948,8 @@
|
|
|
1064
948
|
"type": {
|
|
1065
949
|
"type": "reference",
|
|
1066
950
|
"target": {
|
|
1067
|
-
"
|
|
951
|
+
"packageName": "typescript",
|
|
952
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
1068
953
|
"qualifiedName": "Promise"
|
|
1069
954
|
},
|
|
1070
955
|
"typeArguments": [
|
|
@@ -1080,14 +965,14 @@
|
|
|
1080
965
|
]
|
|
1081
966
|
},
|
|
1082
967
|
{
|
|
1083
|
-
"id":
|
|
968
|
+
"id": 22,
|
|
1084
969
|
"name": "check",
|
|
1085
970
|
"variant": "declaration",
|
|
1086
971
|
"kind": 64,
|
|
1087
972
|
"flags": {},
|
|
1088
973
|
"signatures": [
|
|
1089
974
|
{
|
|
1090
|
-
"id":
|
|
975
|
+
"id": 23,
|
|
1091
976
|
"name": "check",
|
|
1092
977
|
"variant": "signature",
|
|
1093
978
|
"kind": 4096,
|
|
@@ -1166,7 +1051,7 @@
|
|
|
1166
1051
|
},
|
|
1167
1052
|
"parameters": [
|
|
1168
1053
|
{
|
|
1169
|
-
"id":
|
|
1054
|
+
"id": 24,
|
|
1170
1055
|
"name": "channel",
|
|
1171
1056
|
"variant": "param",
|
|
1172
1057
|
"kind": 32768,
|
|
@@ -1181,13 +1066,13 @@
|
|
|
1181
1066
|
},
|
|
1182
1067
|
"type": {
|
|
1183
1068
|
"type": "reference",
|
|
1184
|
-
"target":
|
|
1069
|
+
"target": 46,
|
|
1185
1070
|
"name": "Channel",
|
|
1186
1071
|
"package": "@wix/realtime-common"
|
|
1187
1072
|
}
|
|
1188
1073
|
},
|
|
1189
1074
|
{
|
|
1190
|
-
"id":
|
|
1075
|
+
"id": 25,
|
|
1191
1076
|
"name": "subscriber",
|
|
1192
1077
|
"variant": "param",
|
|
1193
1078
|
"kind": 32768,
|
|
@@ -1202,7 +1087,7 @@
|
|
|
1202
1087
|
},
|
|
1203
1088
|
"type": {
|
|
1204
1089
|
"type": "reference",
|
|
1205
|
-
"target":
|
|
1090
|
+
"target": 51,
|
|
1206
1091
|
"name": "Subscriber",
|
|
1207
1092
|
"package": "@wix/realtime-common"
|
|
1208
1093
|
}
|
|
@@ -1211,13 +1096,14 @@
|
|
|
1211
1096
|
"type": {
|
|
1212
1097
|
"type": "reference",
|
|
1213
1098
|
"target": {
|
|
1214
|
-
"
|
|
1099
|
+
"packageName": "typescript",
|
|
1100
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
1215
1101
|
"qualifiedName": "Promise"
|
|
1216
1102
|
},
|
|
1217
1103
|
"typeArguments": [
|
|
1218
1104
|
{
|
|
1219
1105
|
"type": "reference",
|
|
1220
|
-
"target":
|
|
1106
|
+
"target": 49,
|
|
1221
1107
|
"name": "ChannelPermissions",
|
|
1222
1108
|
"package": "@wix/realtime-common"
|
|
1223
1109
|
}
|
|
@@ -1229,14 +1115,14 @@
|
|
|
1229
1115
|
]
|
|
1230
1116
|
},
|
|
1231
1117
|
{
|
|
1232
|
-
"id":
|
|
1118
|
+
"id": 26,
|
|
1233
1119
|
"name": "default_reserved_word",
|
|
1234
1120
|
"variant": "declaration",
|
|
1235
1121
|
"kind": 64,
|
|
1236
1122
|
"flags": {},
|
|
1237
1123
|
"signatures": [
|
|
1238
1124
|
{
|
|
1239
|
-
"id":
|
|
1125
|
+
"id": 27,
|
|
1240
1126
|
"name": "default_reserved_word",
|
|
1241
1127
|
"variant": "signature",
|
|
1242
1128
|
"kind": 4096,
|
|
@@ -1271,7 +1157,7 @@
|
|
|
1271
1157
|
},
|
|
1272
1158
|
"parameters": [
|
|
1273
1159
|
{
|
|
1274
|
-
"id":
|
|
1160
|
+
"id": 28,
|
|
1275
1161
|
"name": "handler",
|
|
1276
1162
|
"variant": "param",
|
|
1277
1163
|
"kind": 32768,
|
|
@@ -1286,7 +1172,7 @@
|
|
|
1286
1172
|
},
|
|
1287
1173
|
"type": {
|
|
1288
1174
|
"type": "reference",
|
|
1289
|
-
"target":
|
|
1175
|
+
"target": 41,
|
|
1290
1176
|
"name": "PermissionsHandler",
|
|
1291
1177
|
"package": "@wix/sdk_realtime_site"
|
|
1292
1178
|
}
|
|
@@ -1304,27 +1190,27 @@
|
|
|
1304
1190
|
{
|
|
1305
1191
|
"title": "Interfaces",
|
|
1306
1192
|
"children": [
|
|
1307
|
-
|
|
1193
|
+
29
|
|
1308
1194
|
]
|
|
1309
1195
|
},
|
|
1310
1196
|
{
|
|
1311
1197
|
"title": "Type Aliases",
|
|
1312
1198
|
"children": [
|
|
1313
|
-
|
|
1199
|
+
41
|
|
1314
1200
|
]
|
|
1315
1201
|
},
|
|
1316
1202
|
{
|
|
1317
1203
|
"title": "Functions",
|
|
1318
1204
|
"children": [
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1205
|
+
18,
|
|
1206
|
+
22,
|
|
1207
|
+
26
|
|
1322
1208
|
]
|
|
1323
1209
|
}
|
|
1324
1210
|
]
|
|
1325
1211
|
},
|
|
1326
1212
|
{
|
|
1327
|
-
"id":
|
|
1213
|
+
"id": 46,
|
|
1328
1214
|
"name": "Channel",
|
|
1329
1215
|
"variant": "declaration",
|
|
1330
1216
|
"kind": 256,
|
|
@@ -1339,7 +1225,7 @@
|
|
|
1339
1225
|
},
|
|
1340
1226
|
"children": [
|
|
1341
1227
|
{
|
|
1342
|
-
"id":
|
|
1228
|
+
"id": 47,
|
|
1343
1229
|
"name": "name",
|
|
1344
1230
|
"variant": "declaration",
|
|
1345
1231
|
"kind": 1024,
|
|
@@ -1374,7 +1260,7 @@
|
|
|
1374
1260
|
}
|
|
1375
1261
|
},
|
|
1376
1262
|
{
|
|
1377
|
-
"id":
|
|
1263
|
+
"id": 48,
|
|
1378
1264
|
"name": "resourceId",
|
|
1379
1265
|
"variant": "declaration",
|
|
1380
1266
|
"kind": 1024,
|
|
@@ -1399,14 +1285,14 @@
|
|
|
1399
1285
|
{
|
|
1400
1286
|
"title": "Properties",
|
|
1401
1287
|
"children": [
|
|
1402
|
-
|
|
1403
|
-
|
|
1288
|
+
47,
|
|
1289
|
+
48
|
|
1404
1290
|
]
|
|
1405
1291
|
}
|
|
1406
1292
|
]
|
|
1407
1293
|
},
|
|
1408
1294
|
{
|
|
1409
|
-
"id":
|
|
1295
|
+
"id": 49,
|
|
1410
1296
|
"name": "ChannelPermissions",
|
|
1411
1297
|
"variant": "declaration",
|
|
1412
1298
|
"kind": 256,
|
|
@@ -1421,7 +1307,7 @@
|
|
|
1421
1307
|
},
|
|
1422
1308
|
"children": [
|
|
1423
1309
|
{
|
|
1424
|
-
"id":
|
|
1310
|
+
"id": 50,
|
|
1425
1311
|
"name": "read",
|
|
1426
1312
|
"variant": "declaration",
|
|
1427
1313
|
"kind": 1024,
|
|
@@ -1454,13 +1340,13 @@
|
|
|
1454
1340
|
{
|
|
1455
1341
|
"title": "Properties",
|
|
1456
1342
|
"children": [
|
|
1457
|
-
|
|
1343
|
+
50
|
|
1458
1344
|
]
|
|
1459
1345
|
}
|
|
1460
1346
|
]
|
|
1461
1347
|
},
|
|
1462
1348
|
{
|
|
1463
|
-
"id":
|
|
1349
|
+
"id": 54,
|
|
1464
1350
|
"name": "PublishOptions",
|
|
1465
1351
|
"variant": "declaration",
|
|
1466
1352
|
"kind": 256,
|
|
@@ -1475,7 +1361,7 @@
|
|
|
1475
1361
|
},
|
|
1476
1362
|
"children": [
|
|
1477
1363
|
{
|
|
1478
|
-
"id":
|
|
1364
|
+
"id": 56,
|
|
1479
1365
|
"name": "includePublisher",
|
|
1480
1366
|
"variant": "declaration",
|
|
1481
1367
|
"kind": 1024,
|
|
@@ -1504,7 +1390,7 @@
|
|
|
1504
1390
|
}
|
|
1505
1391
|
},
|
|
1506
1392
|
{
|
|
1507
|
-
"id":
|
|
1393
|
+
"id": 55,
|
|
1508
1394
|
"name": "users",
|
|
1509
1395
|
"variant": "declaration",
|
|
1510
1396
|
"kind": 1024,
|
|
@@ -1532,14 +1418,14 @@
|
|
|
1532
1418
|
{
|
|
1533
1419
|
"title": "Properties",
|
|
1534
1420
|
"children": [
|
|
1535
|
-
|
|
1536
|
-
|
|
1421
|
+
56,
|
|
1422
|
+
55
|
|
1537
1423
|
]
|
|
1538
1424
|
}
|
|
1539
1425
|
]
|
|
1540
1426
|
},
|
|
1541
1427
|
{
|
|
1542
|
-
"id":
|
|
1428
|
+
"id": 51,
|
|
1543
1429
|
"name": "Subscriber",
|
|
1544
1430
|
"variant": "declaration",
|
|
1545
1431
|
"kind": 256,
|
|
@@ -1554,7 +1440,7 @@
|
|
|
1554
1440
|
},
|
|
1555
1441
|
"children": [
|
|
1556
1442
|
{
|
|
1557
|
-
"id":
|
|
1443
|
+
"id": 52,
|
|
1558
1444
|
"name": "id",
|
|
1559
1445
|
"variant": "declaration",
|
|
1560
1446
|
"kind": 1024,
|
|
@@ -1584,7 +1470,7 @@
|
|
|
1584
1470
|
}
|
|
1585
1471
|
},
|
|
1586
1472
|
{
|
|
1587
|
-
"id":
|
|
1473
|
+
"id": 53,
|
|
1588
1474
|
"name": "type",
|
|
1589
1475
|
"variant": "declaration",
|
|
1590
1476
|
"kind": 1024,
|
|
@@ -1611,7 +1497,8 @@
|
|
|
1611
1497
|
"type": {
|
|
1612
1498
|
"type": "reference",
|
|
1613
1499
|
"target": {
|
|
1614
|
-
"
|
|
1500
|
+
"packageName": "@wix/realtime-common",
|
|
1501
|
+
"packagePath": "cjs/build/types.d.ts",
|
|
1615
1502
|
"qualifiedName": "SubscriberType"
|
|
1616
1503
|
},
|
|
1617
1504
|
"name": "SubscriberType",
|
|
@@ -1623,17 +1510,17 @@
|
|
|
1623
1510
|
{
|
|
1624
1511
|
"title": "Properties",
|
|
1625
1512
|
"children": [
|
|
1626
|
-
|
|
1627
|
-
|
|
1513
|
+
52,
|
|
1514
|
+
53
|
|
1628
1515
|
]
|
|
1629
1516
|
}
|
|
1630
1517
|
]
|
|
1631
1518
|
},
|
|
1632
1519
|
{
|
|
1633
|
-
"id":
|
|
1520
|
+
"id": 11,
|
|
1634
1521
|
"name": "permissionsRouter",
|
|
1635
1522
|
"variant": "declaration",
|
|
1636
|
-
"kind":
|
|
1523
|
+
"kind": 2097152,
|
|
1637
1524
|
"flags": {
|
|
1638
1525
|
"isReadonly": true
|
|
1639
1526
|
},
|
|
@@ -1658,20 +1545,20 @@
|
|
|
1658
1545
|
},
|
|
1659
1546
|
"type": {
|
|
1660
1547
|
"type": "reference",
|
|
1661
|
-
"target":
|
|
1548
|
+
"target": 29,
|
|
1662
1549
|
"name": "PermissionsRouter",
|
|
1663
1550
|
"package": "@wix/sdk_realtime_site"
|
|
1664
1551
|
}
|
|
1665
1552
|
},
|
|
1666
1553
|
{
|
|
1667
|
-
"id":
|
|
1554
|
+
"id": 2,
|
|
1668
1555
|
"name": "publish",
|
|
1669
1556
|
"variant": "declaration",
|
|
1670
1557
|
"kind": 64,
|
|
1671
1558
|
"flags": {},
|
|
1672
1559
|
"signatures": [
|
|
1673
1560
|
{
|
|
1674
|
-
"id":
|
|
1561
|
+
"id": 3,
|
|
1675
1562
|
"name": "publish",
|
|
1676
1563
|
"variant": "signature",
|
|
1677
1564
|
"kind": 4096,
|
|
@@ -1790,7 +1677,7 @@
|
|
|
1790
1677
|
},
|
|
1791
1678
|
"parameters": [
|
|
1792
1679
|
{
|
|
1793
|
-
"id":
|
|
1680
|
+
"id": 4,
|
|
1794
1681
|
"name": "channel",
|
|
1795
1682
|
"variant": "param",
|
|
1796
1683
|
"kind": 32768,
|
|
@@ -1805,13 +1692,13 @@
|
|
|
1805
1692
|
},
|
|
1806
1693
|
"type": {
|
|
1807
1694
|
"type": "reference",
|
|
1808
|
-
"target":
|
|
1695
|
+
"target": 46,
|
|
1809
1696
|
"name": "Channel",
|
|
1810
1697
|
"package": "@wix/realtime-common"
|
|
1811
1698
|
}
|
|
1812
1699
|
},
|
|
1813
1700
|
{
|
|
1814
|
-
"id":
|
|
1701
|
+
"id": 5,
|
|
1815
1702
|
"name": "payload",
|
|
1816
1703
|
"variant": "param",
|
|
1817
1704
|
"kind": 32768,
|
|
@@ -1830,7 +1717,7 @@
|
|
|
1830
1717
|
}
|
|
1831
1718
|
},
|
|
1832
1719
|
{
|
|
1833
|
-
"id":
|
|
1720
|
+
"id": 6,
|
|
1834
1721
|
"name": "options",
|
|
1835
1722
|
"variant": "param",
|
|
1836
1723
|
"kind": 32768,
|
|
@@ -1847,7 +1734,7 @@
|
|
|
1847
1734
|
},
|
|
1848
1735
|
"type": {
|
|
1849
1736
|
"type": "reference",
|
|
1850
|
-
"target":
|
|
1737
|
+
"target": 54,
|
|
1851
1738
|
"name": "PublishOptions",
|
|
1852
1739
|
"package": "@wix/sdk_realtime_site"
|
|
1853
1740
|
}
|
|
@@ -1856,7 +1743,8 @@
|
|
|
1856
1743
|
"type": {
|
|
1857
1744
|
"type": "reference",
|
|
1858
1745
|
"target": {
|
|
1859
|
-
"
|
|
1746
|
+
"packageName": "typescript",
|
|
1747
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
1860
1748
|
"qualifiedName": "Promise"
|
|
1861
1749
|
},
|
|
1862
1750
|
"typeArguments": [
|
|
@@ -1872,14 +1760,14 @@
|
|
|
1872
1760
|
]
|
|
1873
1761
|
},
|
|
1874
1762
|
{
|
|
1875
|
-
"id":
|
|
1763
|
+
"id": 7,
|
|
1876
1764
|
"name": "realtime_check_permission",
|
|
1877
1765
|
"variant": "declaration",
|
|
1878
1766
|
"kind": 64,
|
|
1879
1767
|
"flags": {},
|
|
1880
1768
|
"signatures": [
|
|
1881
1769
|
{
|
|
1882
|
-
"id":
|
|
1770
|
+
"id": 8,
|
|
1883
1771
|
"name": "realtime_check_permission",
|
|
1884
1772
|
"variant": "signature",
|
|
1885
1773
|
"kind": 4096,
|
|
@@ -1966,7 +1854,7 @@
|
|
|
1966
1854
|
},
|
|
1967
1855
|
"parameters": [
|
|
1968
1856
|
{
|
|
1969
|
-
"id":
|
|
1857
|
+
"id": 9,
|
|
1970
1858
|
"name": "channel",
|
|
1971
1859
|
"variant": "param",
|
|
1972
1860
|
"kind": 32768,
|
|
@@ -1981,13 +1869,13 @@
|
|
|
1981
1869
|
},
|
|
1982
1870
|
"type": {
|
|
1983
1871
|
"type": "reference",
|
|
1984
|
-
"target":
|
|
1872
|
+
"target": 46,
|
|
1985
1873
|
"name": "Channel",
|
|
1986
1874
|
"package": "@wix/realtime-common"
|
|
1987
1875
|
}
|
|
1988
1876
|
},
|
|
1989
1877
|
{
|
|
1990
|
-
"id":
|
|
1878
|
+
"id": 10,
|
|
1991
1879
|
"name": "subscriber",
|
|
1992
1880
|
"variant": "param",
|
|
1993
1881
|
"kind": 32768,
|
|
@@ -2002,7 +1890,7 @@
|
|
|
2002
1890
|
},
|
|
2003
1891
|
"type": {
|
|
2004
1892
|
"type": "reference",
|
|
2005
|
-
"target":
|
|
1893
|
+
"target": 51,
|
|
2006
1894
|
"name": "Subscriber",
|
|
2007
1895
|
"package": "@wix/realtime-common"
|
|
2008
1896
|
}
|
|
@@ -2011,13 +1899,14 @@
|
|
|
2011
1899
|
"type": {
|
|
2012
1900
|
"type": "reference",
|
|
2013
1901
|
"target": {
|
|
2014
|
-
"
|
|
1902
|
+
"packageName": "typescript",
|
|
1903
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
2015
1904
|
"qualifiedName": "Promise"
|
|
2016
1905
|
},
|
|
2017
1906
|
"typeArguments": [
|
|
2018
1907
|
{
|
|
2019
1908
|
"type": "reference",
|
|
2020
|
-
"target":
|
|
1909
|
+
"target": 49,
|
|
2021
1910
|
"name": "ChannelPermissions",
|
|
2022
1911
|
"package": "@wix/realtime-common"
|
|
2023
1912
|
}
|
|
@@ -2033,42 +1922,42 @@
|
|
|
2033
1922
|
{
|
|
2034
1923
|
"title": "Namespaces",
|
|
2035
1924
|
"children": [
|
|
2036
|
-
|
|
1925
|
+
17
|
|
2037
1926
|
]
|
|
2038
1927
|
},
|
|
2039
1928
|
{
|
|
2040
1929
|
"title": "Interfaces",
|
|
2041
1930
|
"children": [
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
|
|
1931
|
+
46,
|
|
1932
|
+
49,
|
|
1933
|
+
54,
|
|
1934
|
+
51
|
|
2046
1935
|
]
|
|
2047
1936
|
},
|
|
2048
1937
|
{
|
|
2049
1938
|
"title": "Type Aliases",
|
|
2050
1939
|
"children": [
|
|
2051
|
-
|
|
1940
|
+
11
|
|
2052
1941
|
]
|
|
2053
1942
|
},
|
|
2054
1943
|
{
|
|
2055
1944
|
"title": "Functions",
|
|
2056
1945
|
"children": [
|
|
2057
|
-
|
|
2058
|
-
|
|
1946
|
+
2,
|
|
1947
|
+
7
|
|
2059
1948
|
]
|
|
2060
1949
|
}
|
|
2061
1950
|
]
|
|
2062
1951
|
},
|
|
2063
1952
|
{
|
|
2064
|
-
"id":
|
|
1953
|
+
"id": 14,
|
|
2065
1954
|
"name": "subscriber",
|
|
2066
1955
|
"variant": "declaration",
|
|
2067
1956
|
"kind": 4,
|
|
2068
1957
|
"flags": {},
|
|
2069
1958
|
"children": [
|
|
2070
1959
|
{
|
|
2071
|
-
"id":
|
|
1960
|
+
"id": 95,
|
|
2072
1961
|
"name": "RealtimeErrorCode",
|
|
2073
1962
|
"variant": "declaration",
|
|
2074
1963
|
"kind": 8,
|
|
@@ -2083,7 +1972,7 @@
|
|
|
2083
1972
|
},
|
|
2084
1973
|
"children": [
|
|
2085
1974
|
{
|
|
2086
|
-
"id":
|
|
1975
|
+
"id": 99,
|
|
2087
1976
|
"name": "BadInput",
|
|
2088
1977
|
"variant": "declaration",
|
|
2089
1978
|
"kind": 16,
|
|
@@ -2102,7 +1991,7 @@
|
|
|
2102
1991
|
}
|
|
2103
1992
|
},
|
|
2104
1993
|
{
|
|
2105
|
-
"id":
|
|
1994
|
+
"id": 97,
|
|
2106
1995
|
"name": "ConnectionError",
|
|
2107
1996
|
"variant": "declaration",
|
|
2108
1997
|
"kind": 16,
|
|
@@ -2121,7 +2010,7 @@
|
|
|
2121
2010
|
}
|
|
2122
2011
|
},
|
|
2123
2012
|
{
|
|
2124
|
-
"id":
|
|
2013
|
+
"id": 96,
|
|
2125
2014
|
"name": "Disconnected",
|
|
2126
2015
|
"variant": "declaration",
|
|
2127
2016
|
"kind": 16,
|
|
@@ -2138,52 +2027,180 @@
|
|
|
2138
2027
|
},
|
|
2139
2028
|
{
|
|
2140
2029
|
"kind": "text",
|
|
2141
|
-
"text": " to determine whether the client is attempting to reconnect."
|
|
2030
|
+
"text": " to determine whether the client is attempting to reconnect."
|
|
2031
|
+
}
|
|
2032
|
+
]
|
|
2033
|
+
},
|
|
2034
|
+
"type": {
|
|
2035
|
+
"type": "literal",
|
|
2036
|
+
"value": "DISCONNECTED"
|
|
2037
|
+
}
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
"id": 98,
|
|
2041
|
+
"name": "SubscriptionFailed",
|
|
2042
|
+
"variant": "declaration",
|
|
2043
|
+
"kind": 16,
|
|
2044
|
+
"flags": {},
|
|
2045
|
+
"comment": {
|
|
2046
|
+
"summary": [
|
|
2047
|
+
{
|
|
2048
|
+
"kind": "text",
|
|
2049
|
+
"text": "Subscription request rejected, for example, due to an authorization failure. This error is non-recoverable."
|
|
2050
|
+
}
|
|
2051
|
+
]
|
|
2052
|
+
},
|
|
2053
|
+
"type": {
|
|
2054
|
+
"type": "literal",
|
|
2055
|
+
"value": "SUBSCRIPTION_FAILED"
|
|
2056
|
+
}
|
|
2057
|
+
}
|
|
2058
|
+
],
|
|
2059
|
+
"groups": [
|
|
2060
|
+
{
|
|
2061
|
+
"title": "Enumeration Members",
|
|
2062
|
+
"children": [
|
|
2063
|
+
99,
|
|
2064
|
+
97,
|
|
2065
|
+
96,
|
|
2066
|
+
98
|
|
2067
|
+
]
|
|
2068
|
+
}
|
|
2069
|
+
]
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"id": 64,
|
|
2073
|
+
"name": "Message",
|
|
2074
|
+
"variant": "declaration",
|
|
2075
|
+
"kind": 256,
|
|
2076
|
+
"flags": {},
|
|
2077
|
+
"comment": {
|
|
2078
|
+
"summary": [
|
|
2079
|
+
{
|
|
2080
|
+
"kind": "text",
|
|
2081
|
+
"text": "Message received on a channel."
|
|
2082
|
+
}
|
|
2083
|
+
]
|
|
2084
|
+
},
|
|
2085
|
+
"children": [
|
|
2086
|
+
{
|
|
2087
|
+
"id": 65,
|
|
2088
|
+
"name": "payload",
|
|
2089
|
+
"variant": "declaration",
|
|
2090
|
+
"kind": 1024,
|
|
2091
|
+
"flags": {},
|
|
2092
|
+
"comment": {
|
|
2093
|
+
"summary": [
|
|
2094
|
+
{
|
|
2095
|
+
"kind": "text",
|
|
2096
|
+
"text": "Message payload that contains the published data.\n\nMax: 10 KB."
|
|
2097
|
+
}
|
|
2098
|
+
]
|
|
2099
|
+
},
|
|
2100
|
+
"type": {
|
|
2101
|
+
"type": "reference",
|
|
2102
|
+
"target": {
|
|
2103
|
+
"packageName": "typescript",
|
|
2104
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
2105
|
+
"qualifiedName": "Record"
|
|
2106
|
+
},
|
|
2107
|
+
"typeArguments": [
|
|
2108
|
+
{
|
|
2109
|
+
"type": "intrinsic",
|
|
2110
|
+
"name": "string"
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"type": "intrinsic",
|
|
2114
|
+
"name": "any"
|
|
2115
|
+
}
|
|
2116
|
+
],
|
|
2117
|
+
"name": "Record",
|
|
2118
|
+
"package": "typescript"
|
|
2119
|
+
}
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
"id": 66,
|
|
2123
|
+
"name": "publisher",
|
|
2124
|
+
"variant": "declaration",
|
|
2125
|
+
"kind": 1024,
|
|
2126
|
+
"flags": {
|
|
2127
|
+
"isOptional": true
|
|
2128
|
+
},
|
|
2129
|
+
"comment": {
|
|
2130
|
+
"summary": [
|
|
2131
|
+
{
|
|
2132
|
+
"kind": "text",
|
|
2133
|
+
"text": "Publisher details.\n\nReturned only when the publisher's identity is available."
|
|
2142
2134
|
}
|
|
2143
2135
|
]
|
|
2144
2136
|
},
|
|
2145
2137
|
"type": {
|
|
2146
|
-
"type": "
|
|
2147
|
-
"
|
|
2138
|
+
"type": "reference",
|
|
2139
|
+
"target": 72,
|
|
2140
|
+
"name": "Publisher",
|
|
2141
|
+
"package": "@wix/realtime-common"
|
|
2148
2142
|
}
|
|
2149
|
-
}
|
|
2143
|
+
}
|
|
2144
|
+
],
|
|
2145
|
+
"groups": [
|
|
2150
2146
|
{
|
|
2151
|
-
"
|
|
2152
|
-
"
|
|
2147
|
+
"title": "Properties",
|
|
2148
|
+
"children": [
|
|
2149
|
+
65,
|
|
2150
|
+
66
|
|
2151
|
+
]
|
|
2152
|
+
}
|
|
2153
|
+
]
|
|
2154
|
+
},
|
|
2155
|
+
{
|
|
2156
|
+
"id": 72,
|
|
2157
|
+
"name": "Publisher",
|
|
2158
|
+
"variant": "declaration",
|
|
2159
|
+
"kind": 256,
|
|
2160
|
+
"flags": {},
|
|
2161
|
+
"comment": {
|
|
2162
|
+
"summary": [
|
|
2163
|
+
{
|
|
2164
|
+
"kind": "text",
|
|
2165
|
+
"text": "Publisher details."
|
|
2166
|
+
}
|
|
2167
|
+
]
|
|
2168
|
+
},
|
|
2169
|
+
"children": [
|
|
2170
|
+
{
|
|
2171
|
+
"id": 73,
|
|
2172
|
+
"name": "id",
|
|
2153
2173
|
"variant": "declaration",
|
|
2154
|
-
"kind":
|
|
2174
|
+
"kind": 1024,
|
|
2155
2175
|
"flags": {},
|
|
2156
2176
|
"comment": {
|
|
2157
2177
|
"summary": [
|
|
2158
2178
|
{
|
|
2159
2179
|
"kind": "text",
|
|
2160
|
-
"text": "
|
|
2180
|
+
"text": "Publisher ID."
|
|
2161
2181
|
}
|
|
2162
2182
|
]
|
|
2163
2183
|
},
|
|
2164
2184
|
"type": {
|
|
2165
|
-
"type": "
|
|
2166
|
-
"
|
|
2185
|
+
"type": "intrinsic",
|
|
2186
|
+
"name": "string"
|
|
2167
2187
|
}
|
|
2168
2188
|
}
|
|
2169
2189
|
],
|
|
2170
2190
|
"groups": [
|
|
2171
2191
|
{
|
|
2172
|
-
"title": "
|
|
2192
|
+
"title": "Properties",
|
|
2173
2193
|
"children": [
|
|
2174
|
-
|
|
2175
|
-
109,
|
|
2176
|
-
108,
|
|
2177
|
-
110
|
|
2194
|
+
73
|
|
2178
2195
|
]
|
|
2179
2196
|
}
|
|
2180
2197
|
]
|
|
2181
2198
|
},
|
|
2182
2199
|
{
|
|
2183
|
-
"id":
|
|
2200
|
+
"id": 90,
|
|
2184
2201
|
"name": "RealtimeError",
|
|
2185
2202
|
"variant": "declaration",
|
|
2186
|
-
"kind":
|
|
2203
|
+
"kind": 256,
|
|
2187
2204
|
"flags": {},
|
|
2188
2205
|
"comment": {
|
|
2189
2206
|
"summary": [
|
|
@@ -2195,137 +2212,7 @@
|
|
|
2195
2212
|
},
|
|
2196
2213
|
"children": [
|
|
2197
2214
|
{
|
|
2198
|
-
"id":
|
|
2199
|
-
"name": "constructor",
|
|
2200
|
-
"variant": "declaration",
|
|
2201
|
-
"kind": 512,
|
|
2202
|
-
"flags": {},
|
|
2203
|
-
"signatures": [
|
|
2204
|
-
{
|
|
2205
|
-
"id": 95,
|
|
2206
|
-
"name": "new RealtimeError",
|
|
2207
|
-
"variant": "signature",
|
|
2208
|
-
"kind": 16384,
|
|
2209
|
-
"flags": {},
|
|
2210
|
-
"parameters": [
|
|
2211
|
-
{
|
|
2212
|
-
"id": 96,
|
|
2213
|
-
"name": "errorCode",
|
|
2214
|
-
"variant": "param",
|
|
2215
|
-
"kind": 32768,
|
|
2216
|
-
"flags": {},
|
|
2217
|
-
"type": {
|
|
2218
|
-
"type": "reference",
|
|
2219
|
-
"target": 107,
|
|
2220
|
-
"name": "RealtimeErrorCode",
|
|
2221
|
-
"package": "@wix/realtime-common"
|
|
2222
|
-
}
|
|
2223
|
-
},
|
|
2224
|
-
{
|
|
2225
|
-
"id": 97,
|
|
2226
|
-
"name": "message",
|
|
2227
|
-
"variant": "param",
|
|
2228
|
-
"kind": 32768,
|
|
2229
|
-
"flags": {},
|
|
2230
|
-
"type": {
|
|
2231
|
-
"type": "intrinsic",
|
|
2232
|
-
"name": "string"
|
|
2233
|
-
}
|
|
2234
|
-
},
|
|
2235
|
-
{
|
|
2236
|
-
"id": 98,
|
|
2237
|
-
"name": "options",
|
|
2238
|
-
"variant": "param",
|
|
2239
|
-
"kind": 32768,
|
|
2240
|
-
"flags": {
|
|
2241
|
-
"isOptional": true
|
|
2242
|
-
},
|
|
2243
|
-
"type": {
|
|
2244
|
-
"type": "reflection",
|
|
2245
|
-
"declaration": {
|
|
2246
|
-
"id": 99,
|
|
2247
|
-
"name": "__type",
|
|
2248
|
-
"variant": "declaration",
|
|
2249
|
-
"kind": 65536,
|
|
2250
|
-
"flags": {},
|
|
2251
|
-
"children": [
|
|
2252
|
-
{
|
|
2253
|
-
"id": 100,
|
|
2254
|
-
"name": "channel",
|
|
2255
|
-
"variant": "declaration",
|
|
2256
|
-
"kind": 1024,
|
|
2257
|
-
"flags": {
|
|
2258
|
-
"isOptional": true
|
|
2259
|
-
},
|
|
2260
|
-
"type": {
|
|
2261
|
-
"type": "reference",
|
|
2262
|
-
"target": 63,
|
|
2263
|
-
"name": "SubscribeChannel",
|
|
2264
|
-
"package": "@wix/realtime-common"
|
|
2265
|
-
}
|
|
2266
|
-
},
|
|
2267
|
-
{
|
|
2268
|
-
"id": 101,
|
|
2269
|
-
"name": "recoverable",
|
|
2270
|
-
"variant": "declaration",
|
|
2271
|
-
"kind": 1024,
|
|
2272
|
-
"flags": {
|
|
2273
|
-
"isOptional": true
|
|
2274
|
-
},
|
|
2275
|
-
"type": {
|
|
2276
|
-
"type": "intrinsic",
|
|
2277
|
-
"name": "boolean"
|
|
2278
|
-
}
|
|
2279
|
-
},
|
|
2280
|
-
{
|
|
2281
|
-
"id": 102,
|
|
2282
|
-
"name": "status",
|
|
2283
|
-
"variant": "declaration",
|
|
2284
|
-
"kind": 1024,
|
|
2285
|
-
"flags": {
|
|
2286
|
-
"isOptional": true
|
|
2287
|
-
},
|
|
2288
|
-
"type": {
|
|
2289
|
-
"type": "intrinsic",
|
|
2290
|
-
"name": "number"
|
|
2291
|
-
}
|
|
2292
|
-
}
|
|
2293
|
-
],
|
|
2294
|
-
"groups": [
|
|
2295
|
-
{
|
|
2296
|
-
"title": "Properties",
|
|
2297
|
-
"children": [
|
|
2298
|
-
100,
|
|
2299
|
-
101,
|
|
2300
|
-
102
|
|
2301
|
-
]
|
|
2302
|
-
}
|
|
2303
|
-
]
|
|
2304
|
-
}
|
|
2305
|
-
}
|
|
2306
|
-
}
|
|
2307
|
-
],
|
|
2308
|
-
"type": {
|
|
2309
|
-
"type": "reference",
|
|
2310
|
-
"target": 93,
|
|
2311
|
-
"name": "RealtimeError",
|
|
2312
|
-
"package": "@wix/realtime-common"
|
|
2313
|
-
},
|
|
2314
|
-
"overwrites": {
|
|
2315
|
-
"type": "reference",
|
|
2316
|
-
"target": -1,
|
|
2317
|
-
"name": "Error.constructor"
|
|
2318
|
-
}
|
|
2319
|
-
}
|
|
2320
|
-
],
|
|
2321
|
-
"overwrites": {
|
|
2322
|
-
"type": "reference",
|
|
2323
|
-
"target": -1,
|
|
2324
|
-
"name": "Error.constructor"
|
|
2325
|
-
}
|
|
2326
|
-
},
|
|
2327
|
-
{
|
|
2328
|
-
"id": 104,
|
|
2215
|
+
"id": 92,
|
|
2329
2216
|
"name": "channel",
|
|
2330
2217
|
"variant": "declaration",
|
|
2331
2218
|
"kind": 1024,
|
|
@@ -2342,13 +2229,13 @@
|
|
|
2342
2229
|
},
|
|
2343
2230
|
"type": {
|
|
2344
2231
|
"type": "reference",
|
|
2345
|
-
"target":
|
|
2232
|
+
"target": 60,
|
|
2346
2233
|
"name": "SubscribeChannel",
|
|
2347
2234
|
"package": "@wix/realtime-common"
|
|
2348
2235
|
}
|
|
2349
2236
|
},
|
|
2350
2237
|
{
|
|
2351
|
-
"id":
|
|
2238
|
+
"id": 91,
|
|
2352
2239
|
"name": "errorCode",
|
|
2353
2240
|
"variant": "declaration",
|
|
2354
2241
|
"kind": 1024,
|
|
@@ -2363,13 +2250,13 @@
|
|
|
2363
2250
|
},
|
|
2364
2251
|
"type": {
|
|
2365
2252
|
"type": "reference",
|
|
2366
|
-
"target":
|
|
2253
|
+
"target": 95,
|
|
2367
2254
|
"name": "RealtimeErrorCode",
|
|
2368
2255
|
"package": "@wix/realtime-common"
|
|
2369
2256
|
}
|
|
2370
2257
|
},
|
|
2371
2258
|
{
|
|
2372
|
-
"id":
|
|
2259
|
+
"id": 93,
|
|
2373
2260
|
"name": "recoverable",
|
|
2374
2261
|
"variant": "declaration",
|
|
2375
2262
|
"kind": 1024,
|
|
@@ -2414,7 +2301,7 @@
|
|
|
2414
2301
|
}
|
|
2415
2302
|
},
|
|
2416
2303
|
{
|
|
2417
|
-
"id":
|
|
2304
|
+
"id": 94,
|
|
2418
2305
|
"name": "status",
|
|
2419
2306
|
"variant": "declaration",
|
|
2420
2307
|
"kind": 1024,
|
|
@@ -2452,19 +2339,13 @@
|
|
|
2452
2339
|
}
|
|
2453
2340
|
],
|
|
2454
2341
|
"groups": [
|
|
2455
|
-
{
|
|
2456
|
-
"title": "Constructors",
|
|
2457
|
-
"children": [
|
|
2458
|
-
94
|
|
2459
|
-
]
|
|
2460
|
-
},
|
|
2461
2342
|
{
|
|
2462
2343
|
"title": "Properties",
|
|
2463
2344
|
"children": [
|
|
2464
|
-
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2345
|
+
92,
|
|
2346
|
+
91,
|
|
2347
|
+
93,
|
|
2348
|
+
94
|
|
2468
2349
|
]
|
|
2469
2350
|
}
|
|
2470
2351
|
],
|
|
@@ -2472,7 +2353,8 @@
|
|
|
2472
2353
|
{
|
|
2473
2354
|
"type": "reference",
|
|
2474
2355
|
"target": {
|
|
2475
|
-
"
|
|
2356
|
+
"packageName": "typescript",
|
|
2357
|
+
"packagePath": "lib/lib.es5.d.ts",
|
|
2476
2358
|
"qualifiedName": "Error"
|
|
2477
2359
|
},
|
|
2478
2360
|
"name": "Error",
|
|
@@ -2481,134 +2363,7 @@
|
|
|
2481
2363
|
]
|
|
2482
2364
|
},
|
|
2483
2365
|
{
|
|
2484
|
-
"id":
|
|
2485
|
-
"name": "Message",
|
|
2486
|
-
"variant": "declaration",
|
|
2487
|
-
"kind": 256,
|
|
2488
|
-
"flags": {},
|
|
2489
|
-
"comment": {
|
|
2490
|
-
"summary": [
|
|
2491
|
-
{
|
|
2492
|
-
"kind": "text",
|
|
2493
|
-
"text": "Message received on a channel."
|
|
2494
|
-
}
|
|
2495
|
-
]
|
|
2496
|
-
},
|
|
2497
|
-
"children": [
|
|
2498
|
-
{
|
|
2499
|
-
"id": 68,
|
|
2500
|
-
"name": "payload",
|
|
2501
|
-
"variant": "declaration",
|
|
2502
|
-
"kind": 1024,
|
|
2503
|
-
"flags": {},
|
|
2504
|
-
"comment": {
|
|
2505
|
-
"summary": [
|
|
2506
|
-
{
|
|
2507
|
-
"kind": "text",
|
|
2508
|
-
"text": "Message payload that contains the published data.\n\nMax: 10 KB."
|
|
2509
|
-
}
|
|
2510
|
-
]
|
|
2511
|
-
},
|
|
2512
|
-
"type": {
|
|
2513
|
-
"type": "reference",
|
|
2514
|
-
"target": {
|
|
2515
|
-
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
2516
|
-
"qualifiedName": "Record"
|
|
2517
|
-
},
|
|
2518
|
-
"typeArguments": [
|
|
2519
|
-
{
|
|
2520
|
-
"type": "intrinsic",
|
|
2521
|
-
"name": "string"
|
|
2522
|
-
},
|
|
2523
|
-
{
|
|
2524
|
-
"type": "intrinsic",
|
|
2525
|
-
"name": "any"
|
|
2526
|
-
}
|
|
2527
|
-
],
|
|
2528
|
-
"name": "Record",
|
|
2529
|
-
"package": "typescript"
|
|
2530
|
-
}
|
|
2531
|
-
},
|
|
2532
|
-
{
|
|
2533
|
-
"id": 69,
|
|
2534
|
-
"name": "publisher",
|
|
2535
|
-
"variant": "declaration",
|
|
2536
|
-
"kind": 1024,
|
|
2537
|
-
"flags": {
|
|
2538
|
-
"isOptional": true
|
|
2539
|
-
},
|
|
2540
|
-
"comment": {
|
|
2541
|
-
"summary": [
|
|
2542
|
-
{
|
|
2543
|
-
"kind": "text",
|
|
2544
|
-
"text": "Publisher details.\n\nReturned only when the publisher's identity is available."
|
|
2545
|
-
}
|
|
2546
|
-
]
|
|
2547
|
-
},
|
|
2548
|
-
"type": {
|
|
2549
|
-
"type": "reference",
|
|
2550
|
-
"target": 75,
|
|
2551
|
-
"name": "Publisher",
|
|
2552
|
-
"package": "@wix/realtime-common"
|
|
2553
|
-
}
|
|
2554
|
-
}
|
|
2555
|
-
],
|
|
2556
|
-
"groups": [
|
|
2557
|
-
{
|
|
2558
|
-
"title": "Properties",
|
|
2559
|
-
"children": [
|
|
2560
|
-
68,
|
|
2561
|
-
69
|
|
2562
|
-
]
|
|
2563
|
-
}
|
|
2564
|
-
]
|
|
2565
|
-
},
|
|
2566
|
-
{
|
|
2567
|
-
"id": 75,
|
|
2568
|
-
"name": "Publisher",
|
|
2569
|
-
"variant": "declaration",
|
|
2570
|
-
"kind": 256,
|
|
2571
|
-
"flags": {},
|
|
2572
|
-
"comment": {
|
|
2573
|
-
"summary": [
|
|
2574
|
-
{
|
|
2575
|
-
"kind": "text",
|
|
2576
|
-
"text": "Publisher details."
|
|
2577
|
-
}
|
|
2578
|
-
]
|
|
2579
|
-
},
|
|
2580
|
-
"children": [
|
|
2581
|
-
{
|
|
2582
|
-
"id": 76,
|
|
2583
|
-
"name": "id",
|
|
2584
|
-
"variant": "declaration",
|
|
2585
|
-
"kind": 1024,
|
|
2586
|
-
"flags": {},
|
|
2587
|
-
"comment": {
|
|
2588
|
-
"summary": [
|
|
2589
|
-
{
|
|
2590
|
-
"kind": "text",
|
|
2591
|
-
"text": "Publisher ID."
|
|
2592
|
-
}
|
|
2593
|
-
]
|
|
2594
|
-
},
|
|
2595
|
-
"type": {
|
|
2596
|
-
"type": "intrinsic",
|
|
2597
|
-
"name": "string"
|
|
2598
|
-
}
|
|
2599
|
-
}
|
|
2600
|
-
],
|
|
2601
|
-
"groups": [
|
|
2602
|
-
{
|
|
2603
|
-
"title": "Properties",
|
|
2604
|
-
"children": [
|
|
2605
|
-
76
|
|
2606
|
-
]
|
|
2607
|
-
}
|
|
2608
|
-
]
|
|
2609
|
-
},
|
|
2610
|
-
{
|
|
2611
|
-
"id": 63,
|
|
2366
|
+
"id": 60,
|
|
2612
2367
|
"name": "SubscribeChannel",
|
|
2613
2368
|
"variant": "declaration",
|
|
2614
2369
|
"kind": 256,
|
|
@@ -2623,7 +2378,7 @@
|
|
|
2623
2378
|
},
|
|
2624
2379
|
"children": [
|
|
2625
2380
|
{
|
|
2626
|
-
"id":
|
|
2381
|
+
"id": 63,
|
|
2627
2382
|
"name": "appId",
|
|
2628
2383
|
"variant": "declaration",
|
|
2629
2384
|
"kind": 1024,
|
|
@@ -2644,7 +2399,7 @@
|
|
|
2644
2399
|
}
|
|
2645
2400
|
},
|
|
2646
2401
|
{
|
|
2647
|
-
"id":
|
|
2402
|
+
"id": 61,
|
|
2648
2403
|
"name": "name",
|
|
2649
2404
|
"variant": "declaration",
|
|
2650
2405
|
"kind": 1024,
|
|
@@ -2679,7 +2434,7 @@
|
|
|
2679
2434
|
}
|
|
2680
2435
|
},
|
|
2681
2436
|
{
|
|
2682
|
-
"id":
|
|
2437
|
+
"id": 62,
|
|
2683
2438
|
"name": "resourceId",
|
|
2684
2439
|
"variant": "declaration",
|
|
2685
2440
|
"kind": 1024,
|
|
@@ -2704,15 +2459,15 @@
|
|
|
2704
2459
|
{
|
|
2705
2460
|
"title": "Properties",
|
|
2706
2461
|
"children": [
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2462
|
+
63,
|
|
2463
|
+
61,
|
|
2464
|
+
62
|
|
2710
2465
|
]
|
|
2711
2466
|
}
|
|
2712
2467
|
]
|
|
2713
2468
|
},
|
|
2714
2469
|
{
|
|
2715
|
-
"id":
|
|
2470
|
+
"id": 84,
|
|
2716
2471
|
"name": "SubscriptionOptions",
|
|
2717
2472
|
"variant": "declaration",
|
|
2718
2473
|
"kind": 256,
|
|
@@ -2727,7 +2482,7 @@
|
|
|
2727
2482
|
},
|
|
2728
2483
|
"children": [
|
|
2729
2484
|
{
|
|
2730
|
-
"id":
|
|
2485
|
+
"id": 85,
|
|
2731
2486
|
"name": "onSubscribed",
|
|
2732
2487
|
"variant": "declaration",
|
|
2733
2488
|
"kind": 1024,
|
|
@@ -2822,13 +2577,13 @@
|
|
|
2822
2577
|
},
|
|
2823
2578
|
"type": {
|
|
2824
2579
|
"type": "reference",
|
|
2825
|
-
"target":
|
|
2580
|
+
"target": 74,
|
|
2826
2581
|
"name": "SubscriptionHandler",
|
|
2827
2582
|
"package": "@wix/realtime-common"
|
|
2828
2583
|
}
|
|
2829
2584
|
},
|
|
2830
2585
|
{
|
|
2831
|
-
"id":
|
|
2586
|
+
"id": 86,
|
|
2832
2587
|
"name": "onSubscriptionError",
|
|
2833
2588
|
"variant": "declaration",
|
|
2834
2589
|
"kind": 1024,
|
|
@@ -2923,7 +2678,7 @@
|
|
|
2923
2678
|
},
|
|
2924
2679
|
"type": {
|
|
2925
2680
|
"type": "reference",
|
|
2926
|
-
"target":
|
|
2681
|
+
"target": 79,
|
|
2927
2682
|
"name": "SubscriptionErrorHandler",
|
|
2928
2683
|
"package": "@wix/realtime-common"
|
|
2929
2684
|
}
|
|
@@ -2933,14 +2688,14 @@
|
|
|
2933
2688
|
{
|
|
2934
2689
|
"title": "Properties",
|
|
2935
2690
|
"children": [
|
|
2936
|
-
|
|
2937
|
-
|
|
2691
|
+
85,
|
|
2692
|
+
86
|
|
2938
2693
|
]
|
|
2939
2694
|
}
|
|
2940
2695
|
]
|
|
2941
2696
|
},
|
|
2942
2697
|
{
|
|
2943
|
-
"id":
|
|
2698
|
+
"id": 87,
|
|
2944
2699
|
"name": "UnsubscribeOptions",
|
|
2945
2700
|
"variant": "declaration",
|
|
2946
2701
|
"kind": 256,
|
|
@@ -2987,7 +2742,7 @@
|
|
|
2987
2742
|
},
|
|
2988
2743
|
"children": [
|
|
2989
2744
|
{
|
|
2990
|
-
"id":
|
|
2745
|
+
"id": 88,
|
|
2991
2746
|
"name": "channel",
|
|
2992
2747
|
"variant": "declaration",
|
|
2993
2748
|
"kind": 1024,
|
|
@@ -3004,13 +2759,13 @@
|
|
|
3004
2759
|
},
|
|
3005
2760
|
"type": {
|
|
3006
2761
|
"type": "reference",
|
|
3007
|
-
"target":
|
|
2762
|
+
"target": 60,
|
|
3008
2763
|
"name": "SubscribeChannel",
|
|
3009
2764
|
"package": "@wix/realtime-common"
|
|
3010
2765
|
}
|
|
3011
2766
|
},
|
|
3012
2767
|
{
|
|
3013
|
-
"id":
|
|
2768
|
+
"id": 89,
|
|
3014
2769
|
"name": "subscriptionId",
|
|
3015
2770
|
"variant": "declaration",
|
|
3016
2771
|
"kind": 1024,
|
|
@@ -3035,44 +2790,44 @@
|
|
|
3035
2790
|
{
|
|
3036
2791
|
"title": "Properties",
|
|
3037
2792
|
"children": [
|
|
3038
|
-
|
|
3039
|
-
|
|
2793
|
+
88,
|
|
2794
|
+
89
|
|
3040
2795
|
]
|
|
3041
2796
|
}
|
|
3042
2797
|
]
|
|
3043
2798
|
},
|
|
3044
2799
|
{
|
|
3045
|
-
"id":
|
|
2800
|
+
"id": 67,
|
|
3046
2801
|
"name": "MessageHandler",
|
|
3047
2802
|
"variant": "declaration",
|
|
3048
|
-
"kind":
|
|
2803
|
+
"kind": 2097152,
|
|
3049
2804
|
"flags": {},
|
|
2805
|
+
"comment": {
|
|
2806
|
+
"summary": [
|
|
2807
|
+
{
|
|
2808
|
+
"kind": "text",
|
|
2809
|
+
"text": "Runs when a message is published to a channel or resource the subscriber listens to."
|
|
2810
|
+
}
|
|
2811
|
+
]
|
|
2812
|
+
},
|
|
3050
2813
|
"type": {
|
|
3051
2814
|
"type": "reflection",
|
|
3052
2815
|
"declaration": {
|
|
3053
|
-
"id":
|
|
2816
|
+
"id": 68,
|
|
3054
2817
|
"name": "__type",
|
|
3055
2818
|
"variant": "declaration",
|
|
3056
2819
|
"kind": 65536,
|
|
3057
2820
|
"flags": {},
|
|
3058
2821
|
"signatures": [
|
|
3059
2822
|
{
|
|
3060
|
-
"id":
|
|
2823
|
+
"id": 69,
|
|
3061
2824
|
"name": "__type",
|
|
3062
2825
|
"variant": "signature",
|
|
3063
2826
|
"kind": 4096,
|
|
3064
2827
|
"flags": {},
|
|
3065
|
-
"comment": {
|
|
3066
|
-
"summary": [
|
|
3067
|
-
{
|
|
3068
|
-
"kind": "text",
|
|
3069
|
-
"text": "Runs when a message is published to a channel or resource the subscriber listens to."
|
|
3070
|
-
}
|
|
3071
|
-
]
|
|
3072
|
-
},
|
|
3073
2828
|
"parameters": [
|
|
3074
2829
|
{
|
|
3075
|
-
"id":
|
|
2830
|
+
"id": 70,
|
|
3076
2831
|
"name": "message",
|
|
3077
2832
|
"variant": "param",
|
|
3078
2833
|
"kind": 32768,
|
|
@@ -3087,13 +2842,13 @@
|
|
|
3087
2842
|
},
|
|
3088
2843
|
"type": {
|
|
3089
2844
|
"type": "reference",
|
|
3090
|
-
"target":
|
|
2845
|
+
"target": 64,
|
|
3091
2846
|
"name": "Message",
|
|
3092
2847
|
"package": "@wix/realtime-common"
|
|
3093
2848
|
}
|
|
3094
2849
|
},
|
|
3095
2850
|
{
|
|
3096
|
-
"id":
|
|
2851
|
+
"id": 71,
|
|
3097
2852
|
"name": "channel",
|
|
3098
2853
|
"variant": "param",
|
|
3099
2854
|
"kind": 32768,
|
|
@@ -3108,7 +2863,7 @@
|
|
|
3108
2863
|
},
|
|
3109
2864
|
"type": {
|
|
3110
2865
|
"type": "reference",
|
|
3111
|
-
"target":
|
|
2866
|
+
"target": 60,
|
|
3112
2867
|
"name": "SubscribeChannel",
|
|
3113
2868
|
"package": "@wix/realtime-common"
|
|
3114
2869
|
}
|
|
@@ -3124,37 +2879,37 @@
|
|
|
3124
2879
|
}
|
|
3125
2880
|
},
|
|
3126
2881
|
{
|
|
3127
|
-
"id":
|
|
2882
|
+
"id": 79,
|
|
3128
2883
|
"name": "SubscriptionErrorHandler",
|
|
3129
2884
|
"variant": "declaration",
|
|
3130
|
-
"kind":
|
|
2885
|
+
"kind": 2097152,
|
|
3131
2886
|
"flags": {},
|
|
2887
|
+
"comment": {
|
|
2888
|
+
"summary": [
|
|
2889
|
+
{
|
|
2890
|
+
"kind": "text",
|
|
2891
|
+
"text": "Runs when a subscription error occurs."
|
|
2892
|
+
}
|
|
2893
|
+
]
|
|
2894
|
+
},
|
|
3132
2895
|
"type": {
|
|
3133
2896
|
"type": "reflection",
|
|
3134
2897
|
"declaration": {
|
|
3135
|
-
"id":
|
|
2898
|
+
"id": 80,
|
|
3136
2899
|
"name": "__type",
|
|
3137
2900
|
"variant": "declaration",
|
|
3138
2901
|
"kind": 65536,
|
|
3139
2902
|
"flags": {},
|
|
3140
2903
|
"signatures": [
|
|
3141
2904
|
{
|
|
3142
|
-
"id":
|
|
2905
|
+
"id": 81,
|
|
3143
2906
|
"name": "__type",
|
|
3144
2907
|
"variant": "signature",
|
|
3145
2908
|
"kind": 4096,
|
|
3146
2909
|
"flags": {},
|
|
3147
|
-
"comment": {
|
|
3148
|
-
"summary": [
|
|
3149
|
-
{
|
|
3150
|
-
"kind": "text",
|
|
3151
|
-
"text": "Runs when a subscription error occurs."
|
|
3152
|
-
}
|
|
3153
|
-
]
|
|
3154
|
-
},
|
|
3155
2910
|
"parameters": [
|
|
3156
2911
|
{
|
|
3157
|
-
"id":
|
|
2912
|
+
"id": 82,
|
|
3158
2913
|
"name": "error",
|
|
3159
2914
|
"variant": "param",
|
|
3160
2915
|
"kind": 32768,
|
|
@@ -3169,13 +2924,13 @@
|
|
|
3169
2924
|
},
|
|
3170
2925
|
"type": {
|
|
3171
2926
|
"type": "reference",
|
|
3172
|
-
"target":
|
|
2927
|
+
"target": 90,
|
|
3173
2928
|
"name": "RealtimeError",
|
|
3174
2929
|
"package": "@wix/realtime-common"
|
|
3175
2930
|
}
|
|
3176
2931
|
},
|
|
3177
2932
|
{
|
|
3178
|
-
"id":
|
|
2933
|
+
"id": 83,
|
|
3179
2934
|
"name": "subscriptionId",
|
|
3180
2935
|
"variant": "param",
|
|
3181
2936
|
"kind": 32768,
|
|
@@ -3204,45 +2959,45 @@
|
|
|
3204
2959
|
}
|
|
3205
2960
|
},
|
|
3206
2961
|
{
|
|
3207
|
-
"id":
|
|
2962
|
+
"id": 74,
|
|
3208
2963
|
"name": "SubscriptionHandler",
|
|
3209
2964
|
"variant": "declaration",
|
|
3210
|
-
"kind":
|
|
2965
|
+
"kind": 2097152,
|
|
3211
2966
|
"flags": {},
|
|
2967
|
+
"comment": {
|
|
2968
|
+
"summary": [
|
|
2969
|
+
{
|
|
2970
|
+
"kind": "text",
|
|
2971
|
+
"text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
|
|
2972
|
+
},
|
|
2973
|
+
{
|
|
2974
|
+
"kind": "code",
|
|
2975
|
+
"text": "`isSynced`"
|
|
2976
|
+
},
|
|
2977
|
+
{
|
|
2978
|
+
"kind": "text",
|
|
2979
|
+
"text": " flag indicates whether all missed messages were successfully delivered.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
|
|
2980
|
+
}
|
|
2981
|
+
]
|
|
2982
|
+
},
|
|
3212
2983
|
"type": {
|
|
3213
2984
|
"type": "reflection",
|
|
3214
2985
|
"declaration": {
|
|
3215
|
-
"id":
|
|
2986
|
+
"id": 75,
|
|
3216
2987
|
"name": "__type",
|
|
3217
2988
|
"variant": "declaration",
|
|
3218
2989
|
"kind": 65536,
|
|
3219
2990
|
"flags": {},
|
|
3220
2991
|
"signatures": [
|
|
3221
2992
|
{
|
|
3222
|
-
"id":
|
|
2993
|
+
"id": 76,
|
|
3223
2994
|
"name": "__type",
|
|
3224
2995
|
"variant": "signature",
|
|
3225
2996
|
"kind": 4096,
|
|
3226
2997
|
"flags": {},
|
|
3227
|
-
"comment": {
|
|
3228
|
-
"summary": [
|
|
3229
|
-
{
|
|
3230
|
-
"kind": "text",
|
|
3231
|
-
"text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
|
|
3232
|
-
},
|
|
3233
|
-
{
|
|
3234
|
-
"kind": "code",
|
|
3235
|
-
"text": "`isSynced`"
|
|
3236
|
-
},
|
|
3237
|
-
{
|
|
3238
|
-
"kind": "text",
|
|
3239
|
-
"text": " flag indicates whether all missed messages were successfully delivered.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
|
|
3240
|
-
}
|
|
3241
|
-
]
|
|
3242
|
-
},
|
|
3243
2998
|
"parameters": [
|
|
3244
2999
|
{
|
|
3245
|
-
"id":
|
|
3000
|
+
"id": 77,
|
|
3246
3001
|
"name": "subscriptionId",
|
|
3247
3002
|
"variant": "param",
|
|
3248
3003
|
"kind": 32768,
|
|
@@ -3261,7 +3016,7 @@
|
|
|
3261
3016
|
}
|
|
3262
3017
|
},
|
|
3263
3018
|
{
|
|
3264
|
-
"id":
|
|
3019
|
+
"id": 78,
|
|
3265
3020
|
"name": "isSynced",
|
|
3266
3021
|
"variant": "param",
|
|
3267
3022
|
"kind": 32768,
|
|
@@ -3290,518 +3045,350 @@
|
|
|
3290
3045
|
}
|
|
3291
3046
|
},
|
|
3292
3047
|
{
|
|
3293
|
-
"id":
|
|
3048
|
+
"id": 15,
|
|
3294
3049
|
"name": "subscribe",
|
|
3295
3050
|
"variant": "declaration",
|
|
3296
|
-
"kind":
|
|
3297
|
-
"flags": {
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
|
|
3305
|
-
|
|
3306
|
-
|
|
3307
|
-
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3314
|
-
|
|
3315
|
-
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3051
|
+
"kind": 32,
|
|
3052
|
+
"flags": {
|
|
3053
|
+
"isConst": true
|
|
3054
|
+
},
|
|
3055
|
+
"comment": {
|
|
3056
|
+
"summary": [
|
|
3057
|
+
{
|
|
3058
|
+
"kind": "text",
|
|
3059
|
+
"text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. It returns the subscription ID immediately while the subscription is attempted in the background.\n\nUse the "
|
|
3060
|
+
},
|
|
3061
|
+
{
|
|
3062
|
+
"kind": "code",
|
|
3063
|
+
"text": "`options`"
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
"kind": "text",
|
|
3067
|
+
"text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"kind": "code",
|
|
3071
|
+
"text": "`onSubscribed()`"
|
|
3072
|
+
},
|
|
3073
|
+
{
|
|
3074
|
+
"kind": "text",
|
|
3075
|
+
"text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
|
|
3076
|
+
}
|
|
3077
|
+
],
|
|
3078
|
+
"blockTags": [
|
|
3079
|
+
{
|
|
3080
|
+
"tag": "@example",
|
|
3081
|
+
"name": "Subscribe to a channel",
|
|
3082
|
+
"content": [
|
|
3319
3083
|
{
|
|
3320
3084
|
"kind": "code",
|
|
3321
|
-
"text": "
|
|
3322
|
-
},
|
|
3323
|
-
{
|
|
3324
|
-
"kind": "text",
|
|
3325
|
-
"text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
|
|
3085
|
+
"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```"
|
|
3326
3086
|
}
|
|
3327
|
-
]
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
"kind": "text",
|
|
3334
|
-
"text": "Subscribe to a channel\n"
|
|
3335
|
-
},
|
|
3336
|
-
{
|
|
3337
|
-
"kind": "code",
|
|
3338
|
-
"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```"
|
|
3339
|
-
}
|
|
3340
|
-
]
|
|
3341
|
-
},
|
|
3342
|
-
{
|
|
3343
|
-
"tag": "@example",
|
|
3344
|
-
"content": [
|
|
3345
|
-
{
|
|
3346
|
-
"kind": "text",
|
|
3347
|
-
"text": "Subscribe to a channel: Self-hosted\n"
|
|
3348
|
-
},
|
|
3349
|
-
{
|
|
3350
|
-
"kind": "code",
|
|
3351
|
-
"text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\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```"
|
|
3352
|
-
}
|
|
3353
|
-
]
|
|
3354
|
-
},
|
|
3355
|
-
{
|
|
3356
|
-
"tag": "@requiredField",
|
|
3357
|
-
"content": [
|
|
3358
|
-
{
|
|
3359
|
-
"kind": "text",
|
|
3360
|
-
"text": "channel"
|
|
3361
|
-
}
|
|
3362
|
-
]
|
|
3363
|
-
},
|
|
3087
|
+
]
|
|
3088
|
+
},
|
|
3089
|
+
{
|
|
3090
|
+
"tag": "@example",
|
|
3091
|
+
"name": "Subscribe to a channel: Self-hosted",
|
|
3092
|
+
"content": [
|
|
3364
3093
|
{
|
|
3365
|
-
"
|
|
3366
|
-
"
|
|
3367
|
-
{
|
|
3368
|
-
"kind": "text",
|
|
3369
|
-
"text": "messageHandler"
|
|
3370
|
-
}
|
|
3371
|
-
]
|
|
3094
|
+
"kind": "code",
|
|
3095
|
+
"text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\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```"
|
|
3372
3096
|
}
|
|
3373
3097
|
]
|
|
3374
3098
|
},
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
|
|
3378
|
-
|
|
3379
|
-
"variant": "param",
|
|
3380
|
-
"kind": 32768,
|
|
3381
|
-
"flags": {},
|
|
3382
|
-
"comment": {
|
|
3383
|
-
"summary": [
|
|
3384
|
-
{
|
|
3385
|
-
"kind": "text",
|
|
3386
|
-
"text": "Channel and resource to subscribe to."
|
|
3387
|
-
}
|
|
3388
|
-
]
|
|
3389
|
-
},
|
|
3390
|
-
"type": {
|
|
3391
|
-
"type": "reference",
|
|
3392
|
-
"target": 63,
|
|
3393
|
-
"name": "SubscribeChannel",
|
|
3394
|
-
"package": "@wix/realtime-common"
|
|
3395
|
-
}
|
|
3396
|
-
},
|
|
3397
|
-
{
|
|
3398
|
-
"id": 115,
|
|
3399
|
-
"name": "messageHandler",
|
|
3400
|
-
"variant": "param",
|
|
3401
|
-
"kind": 32768,
|
|
3402
|
-
"flags": {},
|
|
3403
|
-
"comment": {
|
|
3404
|
-
"summary": [
|
|
3405
|
-
{
|
|
3406
|
-
"kind": "text",
|
|
3407
|
-
"text": "Handler that runs whenever a message is published to the channel or resource."
|
|
3408
|
-
}
|
|
3409
|
-
]
|
|
3410
|
-
},
|
|
3411
|
-
"type": {
|
|
3412
|
-
"type": "reference",
|
|
3413
|
-
"target": 70,
|
|
3414
|
-
"name": "MessageHandler",
|
|
3415
|
-
"package": "@wix/realtime-common"
|
|
3416
|
-
}
|
|
3417
|
-
},
|
|
3418
|
-
{
|
|
3419
|
-
"id": 116,
|
|
3420
|
-
"name": "options",
|
|
3421
|
-
"variant": "param",
|
|
3422
|
-
"kind": 32768,
|
|
3423
|
-
"flags": {
|
|
3424
|
-
"isOptional": true
|
|
3425
|
-
},
|
|
3426
|
-
"comment": {
|
|
3427
|
-
"summary": [
|
|
3428
|
-
{
|
|
3429
|
-
"kind": "text",
|
|
3430
|
-
"text": "[Lifecycle handlers](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle) for subscription events."
|
|
3431
|
-
}
|
|
3432
|
-
]
|
|
3433
|
-
},
|
|
3434
|
-
"type": {
|
|
3435
|
-
"type": "reference",
|
|
3436
|
-
"target": 87,
|
|
3437
|
-
"name": "SubscriptionOptions",
|
|
3438
|
-
"package": "@wix/realtime-common"
|
|
3439
|
-
}
|
|
3440
|
-
}
|
|
3441
|
-
],
|
|
3442
|
-
"type": {
|
|
3443
|
-
"type": "intrinsic",
|
|
3444
|
-
"name": "string"
|
|
3445
|
-
}
|
|
3446
|
-
},
|
|
3447
|
-
{
|
|
3448
|
-
"id": 117,
|
|
3449
|
-
"name": "subscribe",
|
|
3450
|
-
"variant": "signature",
|
|
3451
|
-
"kind": 4096,
|
|
3452
|
-
"flags": {},
|
|
3453
|
-
"comment": {
|
|
3454
|
-
"summary": [
|
|
3099
|
+
{
|
|
3100
|
+
"tag": "@param",
|
|
3101
|
+
"name": "channel",
|
|
3102
|
+
"content": [
|
|
3455
3103
|
{
|
|
3456
3104
|
"kind": "text",
|
|
3457
|
-
"text": "
|
|
3458
|
-
}
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
|
|
3462
|
-
|
|
3105
|
+
"text": "Channel and resource to subscribe to."
|
|
3106
|
+
}
|
|
3107
|
+
]
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
"tag": "@requiredField",
|
|
3111
|
+
"content": [
|
|
3463
3112
|
{
|
|
3464
3113
|
"kind": "text",
|
|
3465
|
-
"text": "
|
|
3466
|
-
}
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
|
|
3114
|
+
"text": "channel"
|
|
3115
|
+
}
|
|
3116
|
+
]
|
|
3117
|
+
},
|
|
3118
|
+
{
|
|
3119
|
+
"tag": "@param",
|
|
3120
|
+
"name": "messageHandler",
|
|
3121
|
+
"content": [
|
|
3471
3122
|
{
|
|
3472
3123
|
"kind": "text",
|
|
3473
|
-
"text": "
|
|
3124
|
+
"text": "Handler that runs whenever a message is published to the channel or resource."
|
|
3474
3125
|
}
|
|
3475
|
-
]
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
{
|
|
3481
|
-
"kind": "text",
|
|
3482
|
-
"text": "Subscribe to a channel\n"
|
|
3483
|
-
},
|
|
3484
|
-
{
|
|
3485
|
-
"kind": "code",
|
|
3486
|
-
"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```"
|
|
3487
|
-
}
|
|
3488
|
-
]
|
|
3489
|
-
},
|
|
3490
|
-
{
|
|
3491
|
-
"tag": "@example",
|
|
3492
|
-
"content": [
|
|
3493
|
-
{
|
|
3494
|
-
"kind": "text",
|
|
3495
|
-
"text": "Subscribe to a channel: Self-hosted\n"
|
|
3496
|
-
},
|
|
3497
|
-
{
|
|
3498
|
-
"kind": "code",
|
|
3499
|
-
"text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\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```"
|
|
3500
|
-
}
|
|
3501
|
-
]
|
|
3502
|
-
},
|
|
3503
|
-
{
|
|
3504
|
-
"tag": "@requiredField",
|
|
3505
|
-
"content": [
|
|
3506
|
-
{
|
|
3507
|
-
"kind": "text",
|
|
3508
|
-
"text": "channel"
|
|
3509
|
-
}
|
|
3510
|
-
]
|
|
3511
|
-
},
|
|
3126
|
+
]
|
|
3127
|
+
},
|
|
3128
|
+
{
|
|
3129
|
+
"tag": "@requiredField",
|
|
3130
|
+
"content": [
|
|
3512
3131
|
{
|
|
3513
|
-
"
|
|
3514
|
-
"
|
|
3515
|
-
{
|
|
3516
|
-
"kind": "text",
|
|
3517
|
-
"text": "messageHandler"
|
|
3518
|
-
}
|
|
3519
|
-
]
|
|
3132
|
+
"kind": "text",
|
|
3133
|
+
"text": "messageHandler"
|
|
3520
3134
|
}
|
|
3521
3135
|
]
|
|
3522
3136
|
},
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3137
|
+
{
|
|
3138
|
+
"tag": "@param",
|
|
3139
|
+
"name": "options",
|
|
3140
|
+
"content": [
|
|
3141
|
+
{
|
|
3142
|
+
"kind": "text",
|
|
3143
|
+
"text": "[Lifecycle handlers](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle) for subscription events."
|
|
3144
|
+
}
|
|
3145
|
+
]
|
|
3146
|
+
}
|
|
3147
|
+
]
|
|
3148
|
+
},
|
|
3149
|
+
"type": {
|
|
3150
|
+
"type": "reference",
|
|
3151
|
+
"target": {
|
|
3152
|
+
"packageName": "@wix/sdk-types",
|
|
3153
|
+
"packagePath": "build/index.d.ts",
|
|
3154
|
+
"qualifiedName": "MaybeContext"
|
|
3155
|
+
},
|
|
3156
|
+
"typeArguments": [
|
|
3157
|
+
{
|
|
3158
|
+
"type": "intersection",
|
|
3159
|
+
"types": [
|
|
3160
|
+
{
|
|
3531
3161
|
"type": "reference",
|
|
3532
3162
|
"target": {
|
|
3533
|
-
"
|
|
3534
|
-
"
|
|
3163
|
+
"packageName": "@wix/sdk-types",
|
|
3164
|
+
"packagePath": "build/index.d.ts",
|
|
3165
|
+
"qualifiedName": "BuildRESTFunction"
|
|
3535
3166
|
},
|
|
3536
|
-
"
|
|
3167
|
+
"typeArguments": [
|
|
3168
|
+
{
|
|
3169
|
+
"type": "query",
|
|
3170
|
+
"queryType": {
|
|
3171
|
+
"type": "reference",
|
|
3172
|
+
"target": {
|
|
3173
|
+
"packageName": "@wix/realtime",
|
|
3174
|
+
"packagePath": "src/subscriber/subscriber.public.ts",
|
|
3175
|
+
"qualifiedName": "subscribe"
|
|
3176
|
+
},
|
|
3177
|
+
"name": "publicSubscribe",
|
|
3178
|
+
"package": "@wix/realtime",
|
|
3179
|
+
"qualifiedName": "subscribe",
|
|
3180
|
+
"preferValues": true
|
|
3181
|
+
}
|
|
3182
|
+
}
|
|
3183
|
+
],
|
|
3184
|
+
"name": "BuildRESTFunction",
|
|
3537
3185
|
"package": "@wix/sdk-types"
|
|
3186
|
+
},
|
|
3187
|
+
{
|
|
3188
|
+
"type": "query",
|
|
3189
|
+
"queryType": {
|
|
3190
|
+
"type": "reference",
|
|
3191
|
+
"target": {
|
|
3192
|
+
"packageName": "@wix/realtime",
|
|
3193
|
+
"packagePath": "src/subscriber/subscriber.public.ts",
|
|
3194
|
+
"qualifiedName": "subscribe"
|
|
3195
|
+
},
|
|
3196
|
+
"name": "publicSubscribe",
|
|
3197
|
+
"package": "@wix/realtime",
|
|
3198
|
+
"qualifiedName": "subscribe",
|
|
3199
|
+
"preferValues": true
|
|
3200
|
+
}
|
|
3538
3201
|
}
|
|
3539
|
-
|
|
3540
|
-
],
|
|
3541
|
-
"type": {
|
|
3542
|
-
"type": "reference",
|
|
3543
|
-
"target": {
|
|
3544
|
-
"sourceFileName": "src/subscriber/subscriber.public.ts",
|
|
3545
|
-
"qualifiedName": "SubscribeSignature"
|
|
3546
|
-
},
|
|
3547
|
-
"name": "SubscribeSignature",
|
|
3548
|
-
"package": "@wix/realtime"
|
|
3202
|
+
]
|
|
3549
3203
|
}
|
|
3550
|
-
|
|
3551
|
-
|
|
3204
|
+
],
|
|
3205
|
+
"name": "MaybeContext",
|
|
3206
|
+
"package": "@wix/sdk-types"
|
|
3207
|
+
},
|
|
3208
|
+
"defaultValue": "..."
|
|
3552
3209
|
},
|
|
3553
3210
|
{
|
|
3554
|
-
"id":
|
|
3211
|
+
"id": 16,
|
|
3555
3212
|
"name": "unsubscribe",
|
|
3556
3213
|
"variant": "declaration",
|
|
3557
|
-
"kind":
|
|
3558
|
-
"flags": {
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
|
|
3214
|
+
"kind": 32,
|
|
3215
|
+
"flags": {
|
|
3216
|
+
"isConst": true
|
|
3217
|
+
},
|
|
3218
|
+
"comment": {
|
|
3219
|
+
"summary": [
|
|
3220
|
+
{
|
|
3221
|
+
"kind": "text",
|
|
3222
|
+
"text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
|
|
3223
|
+
},
|
|
3224
|
+
{
|
|
3225
|
+
"kind": "code",
|
|
3226
|
+
"text": "`subscriptionId`"
|
|
3227
|
+
},
|
|
3228
|
+
{
|
|
3229
|
+
"kind": "text",
|
|
3230
|
+
"text": ": removes a single subscription.\n- By "
|
|
3231
|
+
},
|
|
3232
|
+
{
|
|
3233
|
+
"kind": "code",
|
|
3234
|
+
"text": "`channel`"
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
"kind": "text",
|
|
3238
|
+
"text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
|
|
3239
|
+
}
|
|
3240
|
+
],
|
|
3241
|
+
"blockTags": [
|
|
3242
|
+
{
|
|
3243
|
+
"tag": "@example",
|
|
3244
|
+
"name": "Remove the specified subscription.",
|
|
3245
|
+
"content": [
|
|
3580
3246
|
{
|
|
3581
3247
|
"kind": "code",
|
|
3582
|
-
"text": "
|
|
3583
|
-
},
|
|
3584
|
-
{
|
|
3585
|
-
"kind": "text",
|
|
3586
|
-
"text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
|
|
3248
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
|
|
3587
3249
|
}
|
|
3588
|
-
]
|
|
3589
|
-
|
|
3590
|
-
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
"kind": "text",
|
|
3595
|
-
"text": "Remove the specified subscription.\n"
|
|
3596
|
-
},
|
|
3597
|
-
{
|
|
3598
|
-
"kind": "code",
|
|
3599
|
-
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
|
|
3600
|
-
}
|
|
3601
|
-
]
|
|
3602
|
-
},
|
|
3603
|
-
{
|
|
3604
|
-
"tag": "@example",
|
|
3605
|
-
"content": [
|
|
3606
|
-
{
|
|
3607
|
-
"kind": "text",
|
|
3608
|
-
"text": "Remove the specified subscription: Self-hosted\n"
|
|
3609
|
-
},
|
|
3610
|
-
{
|
|
3611
|
-
"kind": "code",
|
|
3612
|
-
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
|
|
3613
|
-
}
|
|
3614
|
-
]
|
|
3615
|
-
},
|
|
3250
|
+
]
|
|
3251
|
+
},
|
|
3252
|
+
{
|
|
3253
|
+
"tag": "@example",
|
|
3254
|
+
"name": "Remove the specified subscription: Self-hosted",
|
|
3255
|
+
"content": [
|
|
3616
3256
|
{
|
|
3617
|
-
"
|
|
3618
|
-
"
|
|
3619
|
-
{
|
|
3620
|
-
"kind": "text",
|
|
3621
|
-
"text": "options"
|
|
3622
|
-
}
|
|
3623
|
-
]
|
|
3257
|
+
"kind": "code",
|
|
3258
|
+
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
|
|
3624
3259
|
}
|
|
3625
3260
|
]
|
|
3626
3261
|
},
|
|
3627
|
-
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
"variant": "param",
|
|
3632
|
-
"kind": 32768,
|
|
3633
|
-
"flags": {},
|
|
3634
|
-
"comment": {
|
|
3635
|
-
"summary": [
|
|
3636
|
-
{
|
|
3637
|
-
"kind": "text",
|
|
3638
|
-
"text": "Unsubscribe details. You must specify "
|
|
3639
|
-
},
|
|
3640
|
-
{
|
|
3641
|
-
"kind": "code",
|
|
3642
|
-
"text": "`channel`"
|
|
3643
|
-
},
|
|
3644
|
-
{
|
|
3645
|
-
"kind": "text",
|
|
3646
|
-
"text": ", "
|
|
3647
|
-
},
|
|
3648
|
-
{
|
|
3649
|
-
"kind": "code",
|
|
3650
|
-
"text": "`subscriptionId`"
|
|
3651
|
-
},
|
|
3652
|
-
{
|
|
3653
|
-
"kind": "text",
|
|
3654
|
-
"text": ", or both."
|
|
3655
|
-
}
|
|
3656
|
-
]
|
|
3657
|
-
},
|
|
3658
|
-
"type": {
|
|
3659
|
-
"type": "reference",
|
|
3660
|
-
"target": 90,
|
|
3661
|
-
"name": "UnsubscribeOptions",
|
|
3662
|
-
"package": "@wix/realtime-common"
|
|
3663
|
-
}
|
|
3664
|
-
}
|
|
3665
|
-
],
|
|
3666
|
-
"type": {
|
|
3667
|
-
"type": "intrinsic",
|
|
3668
|
-
"name": "void"
|
|
3669
|
-
}
|
|
3670
|
-
},
|
|
3671
|
-
{
|
|
3672
|
-
"id": 122,
|
|
3673
|
-
"name": "unsubscribe",
|
|
3674
|
-
"variant": "signature",
|
|
3675
|
-
"kind": 4096,
|
|
3676
|
-
"flags": {},
|
|
3677
|
-
"comment": {
|
|
3678
|
-
"summary": [
|
|
3262
|
+
{
|
|
3263
|
+
"tag": "@param",
|
|
3264
|
+
"name": "options",
|
|
3265
|
+
"content": [
|
|
3679
3266
|
{
|
|
3680
3267
|
"kind": "text",
|
|
3681
|
-
"text": "
|
|
3268
|
+
"text": "Unsubscribe details. You must specify "
|
|
3682
3269
|
},
|
|
3683
3270
|
{
|
|
3684
3271
|
"kind": "code",
|
|
3685
|
-
"text": "`
|
|
3272
|
+
"text": "`channel`"
|
|
3686
3273
|
},
|
|
3687
3274
|
{
|
|
3688
3275
|
"kind": "text",
|
|
3689
|
-
"text": "
|
|
3276
|
+
"text": ", "
|
|
3690
3277
|
},
|
|
3691
3278
|
{
|
|
3692
3279
|
"kind": "code",
|
|
3693
|
-
"text": "`
|
|
3280
|
+
"text": "`subscriptionId`"
|
|
3694
3281
|
},
|
|
3695
3282
|
{
|
|
3696
3283
|
"kind": "text",
|
|
3697
|
-
"text": "
|
|
3284
|
+
"text": ", or both."
|
|
3698
3285
|
}
|
|
3699
|
-
]
|
|
3700
|
-
|
|
3701
|
-
|
|
3702
|
-
|
|
3703
|
-
|
|
3704
|
-
{
|
|
3705
|
-
"kind": "text",
|
|
3706
|
-
"text": "Remove the specified subscription.\n"
|
|
3707
|
-
},
|
|
3708
|
-
{
|
|
3709
|
-
"kind": "code",
|
|
3710
|
-
"text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
|
|
3711
|
-
}
|
|
3712
|
-
]
|
|
3713
|
-
},
|
|
3714
|
-
{
|
|
3715
|
-
"tag": "@example",
|
|
3716
|
-
"content": [
|
|
3717
|
-
{
|
|
3718
|
-
"kind": "text",
|
|
3719
|
-
"text": "Remove the specified subscription: Self-hosted\n"
|
|
3720
|
-
},
|
|
3721
|
-
{
|
|
3722
|
-
"kind": "code",
|
|
3723
|
-
"text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n modules: { subscriber },\n // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
|
|
3724
|
-
}
|
|
3725
|
-
]
|
|
3726
|
-
},
|
|
3286
|
+
]
|
|
3287
|
+
},
|
|
3288
|
+
{
|
|
3289
|
+
"tag": "@requiredField",
|
|
3290
|
+
"content": [
|
|
3727
3291
|
{
|
|
3728
|
-
"
|
|
3729
|
-
"
|
|
3730
|
-
{
|
|
3731
|
-
"kind": "text",
|
|
3732
|
-
"text": "options"
|
|
3733
|
-
}
|
|
3734
|
-
]
|
|
3292
|
+
"kind": "text",
|
|
3293
|
+
"text": "options"
|
|
3735
3294
|
}
|
|
3736
3295
|
]
|
|
3737
|
-
}
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
|
|
3296
|
+
}
|
|
3297
|
+
]
|
|
3298
|
+
},
|
|
3299
|
+
"type": {
|
|
3300
|
+
"type": "reference",
|
|
3301
|
+
"target": {
|
|
3302
|
+
"packageName": "@wix/sdk-types",
|
|
3303
|
+
"packagePath": "build/index.d.ts",
|
|
3304
|
+
"qualifiedName": "MaybeContext"
|
|
3305
|
+
},
|
|
3306
|
+
"typeArguments": [
|
|
3307
|
+
{
|
|
3308
|
+
"type": "intersection",
|
|
3309
|
+
"types": [
|
|
3310
|
+
{
|
|
3746
3311
|
"type": "reference",
|
|
3747
3312
|
"target": {
|
|
3748
|
-
"
|
|
3749
|
-
"
|
|
3313
|
+
"packageName": "@wix/sdk-types",
|
|
3314
|
+
"packagePath": "build/index.d.ts",
|
|
3315
|
+
"qualifiedName": "BuildRESTFunction"
|
|
3750
3316
|
},
|
|
3751
|
-
"
|
|
3317
|
+
"typeArguments": [
|
|
3318
|
+
{
|
|
3319
|
+
"type": "query",
|
|
3320
|
+
"queryType": {
|
|
3321
|
+
"type": "reference",
|
|
3322
|
+
"target": {
|
|
3323
|
+
"packageName": "@wix/realtime",
|
|
3324
|
+
"packagePath": "src/subscriber/subscriber.public.ts",
|
|
3325
|
+
"qualifiedName": "unsubscribe"
|
|
3326
|
+
},
|
|
3327
|
+
"name": "publicUnsubscribe",
|
|
3328
|
+
"package": "@wix/realtime",
|
|
3329
|
+
"qualifiedName": "unsubscribe",
|
|
3330
|
+
"preferValues": true
|
|
3331
|
+
}
|
|
3332
|
+
}
|
|
3333
|
+
],
|
|
3334
|
+
"name": "BuildRESTFunction",
|
|
3752
3335
|
"package": "@wix/sdk-types"
|
|
3336
|
+
},
|
|
3337
|
+
{
|
|
3338
|
+
"type": "query",
|
|
3339
|
+
"queryType": {
|
|
3340
|
+
"type": "reference",
|
|
3341
|
+
"target": {
|
|
3342
|
+
"packageName": "@wix/realtime",
|
|
3343
|
+
"packagePath": "src/subscriber/subscriber.public.ts",
|
|
3344
|
+
"qualifiedName": "unsubscribe"
|
|
3345
|
+
},
|
|
3346
|
+
"name": "publicUnsubscribe",
|
|
3347
|
+
"package": "@wix/realtime",
|
|
3348
|
+
"qualifiedName": "unsubscribe",
|
|
3349
|
+
"preferValues": true
|
|
3350
|
+
}
|
|
3753
3351
|
}
|
|
3754
|
-
|
|
3755
|
-
],
|
|
3756
|
-
"type": {
|
|
3757
|
-
"type": "reference",
|
|
3758
|
-
"target": {
|
|
3759
|
-
"sourceFileName": "src/subscriber/subscriber.public.ts",
|
|
3760
|
-
"qualifiedName": "UnsubscribeSignature"
|
|
3761
|
-
},
|
|
3762
|
-
"name": "UnsubscribeSignature",
|
|
3763
|
-
"package": "@wix/realtime"
|
|
3352
|
+
]
|
|
3764
3353
|
}
|
|
3765
|
-
|
|
3766
|
-
|
|
3354
|
+
],
|
|
3355
|
+
"name": "MaybeContext",
|
|
3356
|
+
"package": "@wix/sdk-types"
|
|
3357
|
+
},
|
|
3358
|
+
"defaultValue": "..."
|
|
3767
3359
|
}
|
|
3768
3360
|
],
|
|
3769
3361
|
"groups": [
|
|
3770
3362
|
{
|
|
3771
3363
|
"title": "Enumerations",
|
|
3772
3364
|
"children": [
|
|
3773
|
-
|
|
3774
|
-
]
|
|
3775
|
-
},
|
|
3776
|
-
{
|
|
3777
|
-
"title": "Classes",
|
|
3778
|
-
"children": [
|
|
3779
|
-
93
|
|
3365
|
+
95
|
|
3780
3366
|
]
|
|
3781
3367
|
},
|
|
3782
3368
|
{
|
|
3783
3369
|
"title": "Interfaces",
|
|
3784
3370
|
"children": [
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
|
|
3371
|
+
64,
|
|
3372
|
+
72,
|
|
3373
|
+
90,
|
|
3374
|
+
60,
|
|
3375
|
+
84,
|
|
3376
|
+
87
|
|
3790
3377
|
]
|
|
3791
3378
|
},
|
|
3792
3379
|
{
|
|
3793
3380
|
"title": "Type Aliases",
|
|
3794
3381
|
"children": [
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3382
|
+
67,
|
|
3383
|
+
79,
|
|
3384
|
+
74
|
|
3798
3385
|
]
|
|
3799
3386
|
},
|
|
3800
3387
|
{
|
|
3801
|
-
"title": "
|
|
3388
|
+
"title": "Variables",
|
|
3802
3389
|
"children": [
|
|
3803
|
-
|
|
3804
|
-
|
|
3390
|
+
15,
|
|
3391
|
+
16
|
|
3805
3392
|
]
|
|
3806
3393
|
}
|
|
3807
3394
|
]
|
|
@@ -3811,14 +3398,30 @@
|
|
|
3811
3398
|
{
|
|
3812
3399
|
"title": "Namespaces",
|
|
3813
3400
|
"children": [
|
|
3814
|
-
|
|
3401
|
+
12,
|
|
3815
3402
|
1,
|
|
3816
|
-
|
|
3403
|
+
14
|
|
3817
3404
|
]
|
|
3818
3405
|
}
|
|
3819
3406
|
],
|
|
3820
3407
|
"packageName": "@wix/realtime",
|
|
3821
|
-
"symbolIdMap": {}
|
|
3408
|
+
"symbolIdMap": {},
|
|
3409
|
+
"files": {
|
|
3410
|
+
"entries": {
|
|
3411
|
+
"1": "src/doc-types/index.ts",
|
|
3412
|
+
"2": "../site/src/doc-types/index.ts",
|
|
3413
|
+
"3": "src/publisher/publisher.context.ts",
|
|
3414
|
+
"4": "src/subscriber/subscriber.context.ts",
|
|
3415
|
+
"5": "../site/src/doc-types/src/permissionsrouter.ts"
|
|
3416
|
+
},
|
|
3417
|
+
"reflections": {
|
|
3418
|
+
"1": 0,
|
|
3419
|
+
"2": 1,
|
|
3420
|
+
"3": 12,
|
|
3421
|
+
"4": 14,
|
|
3422
|
+
"5": 17
|
|
3423
|
+
}
|
|
3424
|
+
}
|
|
3822
3425
|
},
|
|
3823
3426
|
"appendices": {
|
|
3824
3427
|
"/publisher": [
|