Debian Codegraph @

doc/jsxc.xmpp.carbons.html

raw
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <title>JSDoc: Namespace: carbons</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14 </head>
15
16 <body>
17
18 <div id="main">
19
20 <h1 class="page-title">Namespace: carbons</h1>
21
22
23
24
25
26
27 <section>
28
29 <header>
30
31 <h2>
32 <span class="ancestors"><a href="jsxc.html">jsxc</a><a href="jsxc.xmpp.html">.xmpp</a>.</span>carbons</h2>
33
34
35 </header>
36
37 <article>
38 <div class="container-overview">
39
40
41 <div class="description">Handle carbons (XEP-0280);</div>
42
43
44
45
46
47 <dl class="details">
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74 <dt class="tag-source">Source:</dt>
75 <dd class="tag-source"><ul class="dummy"><li>
76 <a href="jsxc.lib.xmpp.js.html">jsxc.lib.xmpp.js</a>, <a href="jsxc.lib.xmpp.js.html#line1492">line 1492</a>
77 </li></ul></dd>
78
79
80
81
82
83
84
85 </dl>
86
87
88
89
90 </div>
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107 <h3 class="subsection-title">Methods</h3>
108
109
110
111
112
113
114
115 <h4 class="name" id=".disable"><span class="type-signature">(static) </span>disable<span class="signature">(cb)</span><span class="type-signature"></span></h4>
116
117
118
119
120
121
122 <div class="description">
123 Disable carbons.
124 </div>
125
126
127
128
129
130
131
132
133
134 <h5>Parameters:</h5>
135
136
137 <table class="params">
138 <thead>
139 <tr>
140
141 <th>Name</th>
142
143
144 <th>Type</th>
145
146
147
148
149
150 <th class="last">Description</th>
151 </tr>
152 </thead>
153
154 <tbody>
155
156
157 <tr>
158
159 <td class="name"><code>cb</code></td>
160
161
162 <td class="type">
163
164 </td>
165
166
167
168
169
170 <td class="description last">callback</td>
171 </tr>
172
173
174 </tbody>
175 </table>
176
177
178
179
180
181
182 <dl class="details">
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209 <dt class="tag-source">Source:</dt>
210 <dd class="tag-source"><ul class="dummy"><li>
211 <a href="jsxc.lib.xmpp.js.html">jsxc.lib.xmpp.js</a>, <a href="jsxc.lib.xmpp.js.html#line1532">line 1532</a>
212 </li></ul></dd>
213
214
215
216
217
218
219
220 </dl>
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245 <h4 class="name" id=".enable"><span class="type-signature">(static) </span>enable<span class="signature">(cb)</span><span class="type-signature"></span></h4>
246
247
248
249
250
251
252 <div class="description">
253 Enable carbons.
254 </div>
255
256
257
258
259
260
261
262
263
264 <h5>Parameters:</h5>
265
266
267 <table class="params">
268 <thead>
269 <tr>
270
271 <th>Name</th>
272
273
274 <th>Type</th>
275
276
277
278
279
280 <th class="last">Description</th>
281 </tr>
282 </thead>
283
284 <tbody>
285
286
287 <tr>
288
289 <td class="name"><code>cb</code></td>
290
291
292 <td class="type">
293
294 </td>
295
296
297
298
299
300 <td class="description last">callback</td>
301 </tr>
302
303
304 </tbody>
305 </table>
306
307
308
309
310
311
312 <dl class="details">
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339 <dt class="tag-source">Source:</dt>
340 <dd class="tag-source"><ul class="dummy"><li>
341 <a href="jsxc.lib.xmpp.js.html">jsxc.lib.xmpp.js</a>, <a href="jsxc.lib.xmpp.js.html#line1506">line 1506</a>
342 </li></ul></dd>
343
344
345
346
347
348
349
350 </dl>
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375 <h4 class="name" id=".refresh"><span class="type-signature">(static) </span>refresh<span class="signature">(err)</span><span class="type-signature"></span></h4>
376
377
378
379
380
381
382 <div class="description">
383 Enable/Disable carbons depending on options key.
384 </div>
385
386
387
388
389
390
391
392
393
394 <h5>Parameters:</h5>
395
396
397 <table class="params">
398 <thead>
399 <tr>
400
401 <th>Name</th>
402
403
404 <th>Type</th>
405
406
407
408
409
410 <th class="last">Description</th>
411 </tr>
412 </thead>
413
414 <tbody>
415
416
417 <tr>
418
419 <td class="name"><code>err</code></td>
420
421
422 <td class="type">
423
424 </td>
425
426
427
428
429
430 <td class="description last">error message</td>
431 </tr>
432
433
434 </tbody>
435 </table>
436
437
438
439
440
441
442 <dl class="details">
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469 <dt class="tag-source">Source:</dt>
470 <dd class="tag-source"><ul class="dummy"><li>
471 <a href="jsxc.lib.xmpp.js.html">jsxc.lib.xmpp.js</a>, <a href="jsxc.lib.xmpp.js.html#line1558">line 1558</a>
472 </li></ul></dd>
473
474
475
476
477
478
479
480 </dl>
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505 </article>
506
507 </section>
508
509
510
511
512 </div>
513
514 <nav>
515 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="jsxc.Message.html">Message</a></li></ul><h3>Namespaces</h3><ul><li><a href="jsxc.html">jsxc</a></li><li><a href="jsxc.fileTransfer.html">fileTransfer</a></li><li><a href="jsxc.gui.html">gui</a></li><li><a href="jsxc.gui.dialog.html">dialog</a></li><li><a href="jsxc.gui.queryActions.html">queryActions</a></li><li><a href="jsxc.gui.roster.html">roster</a></li><li><a href="jsxc.gui.window.html">window</a></li><li><a href="jsxc.muc.html">muc</a></li><li><a href="jsxc.notification.html">notification</a></li><li><a href="jsxc.options.html">options</a></li><li><a href="jsxc.otr.html">otr</a></li><li><a href="jsxc.storage.html">storage</a></li><li><a href="jsxc.tab.html">tab</a></li><li><a href="jsxc.webrtc.html">webrtc</a></li><li><a href="jsxc.xmpp.html">xmpp</a></li><li><a href="jsxc.xmpp.bookmarks.html">bookmarks</a></li><li><a href="jsxc.xmpp.carbons.html">carbons</a></li><li><a href="jsxc.xmpp.chatState.html">chatState</a></li><li><a href="jsxc.xmpp.httpUpload.html">httpUpload</a></li><li><a href="jsxc.xmpp.mam.html">mam</a></li></ul><h3><a href="global.html">Global</a></h3>
516 </nav>
517
518 <br class="clear">
519
520 <footer>
521 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri May 10 2019 12:36:12 GMT+0200 (Central European Summer Time)
522 </footer>
523
524 <script> prettyPrint(); </script>
525 <script src="scripts/linenumber.js"> </script>
526 </body>
527 </html>