← Back to branch summary

~webapps/unity-webapps-qml/15.04

« back to all changes in this revision

Viewing changes to src/Ubuntu/UnityWebApps/bindings/content-hub/client/docsbuild/data.json

  • Committer: CI Train Bot
  • Author(s): Daniel Holbach
  • Date: 2015-04-09 13:29:10 UTC
  • mfrom: (148.1.5 unity-webapps-qml)
  • Revision ID: ci-train-bot@canonical.com-20150409132910-mmui8imfjseapg7f
Add ./update-docs script which generates API docs locally. We can't make this part of the build as not all node dependencies of yuidocsjs are packaged in the archive.
Approved by: PS Jenkins bot, David Barth

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/Ubuntu/UnityWebApps/bindings/content-hub/client/docsbuild/data.json
 
1
{
 
2
    "project": {
 
3
        "name": "Content Hub JS API",
 
4
        "description": "Ubuntu App Platform Content Hub JavaScript API docs",
 
5
        "version": "0.1"
 
6
    },
 
7
    "files": {
 
8
        "content-hub.js": {
 
9
            "name": "content-hub.js",
 
10
            "modules": {
 
11
                "ContentHub": 1
 
12
            },
 
13
            "classes": {
 
14
                "ContentTransfer": 1,
 
15
                "ContentPeer": 1,
 
16
                "ContentStore": 1,
 
17
                "ContentHub": 1
 
18
            },
 
19
            "fors": {},
 
20
            "namespaces": {}
 
21
        }
 
22
    },
 
23
    "modules": {
 
24
        "ContentHub": {
 
25
            "name": "ContentHub",
 
26
            "submodules": {},
 
27
            "classes": {
 
28
                "ContentTransfer": 1,
 
29
                "ContentPeer": 1,
 
30
                "ContentStore": 1,
 
31
                "ContentHub": 1
 
32
            },
 
33
            "fors": {},
 
34
            "namespaces": {},
 
35
            "tag": "module",
 
36
            "file": "content-hub.js",
 
37
            "line": 568,
 
38
            "description": "ContentHub is the entry point to resource io transfer\n  from/to remote applications (peers)."
 
39
        }
 
40
    },
 
41
    "classes": {
 
42
        "ContentTransfer": {
 
43
            "name": "ContentTransfer",
 
44
            "shortname": "ContentTransfer",
 
45
            "classitems": [],
 
46
            "plugins": [],
 
47
            "extensions": [],
 
48
            "plugin_for": [],
 
49
            "extension_for": [],
 
50
            "module": "ContentHub",
 
51
            "namespace": "",
 
52
            "file": "content-hub.js",
 
53
            "line": 11,
 
54
            "description": "ContentTransfer is an object created by the ContentHub to\n  and allows one to properly setup and manage a data\n  transfer between two peers.",
 
55
            "is_constructor": 1,
 
56
            "example": [
 
57
                "\n\n      var api = external.getUnityObject('1.0');\n      var hub = api.ContentHub;\n\n      var pictureContentType = hub.ContentType.Pictures;\n\n      hub.defaultSourceForType(\n         pictureContentType\n         , function(peer) {\n           hub.importContentForPeer(\n             pictureContentType,\n             peer,\n             function(transfer) {\n               [setup the transfer options and store]\n               transfer.start(function(state) { [...] });\n             });\n          });"
 
58
            ]
 
59
        },
 
60
        "ContentPeer": {
 
61
            "name": "ContentPeer",
 
62
            "shortname": "ContentPeer",
 
63
            "classitems": [],
 
64
            "plugins": [],
 
65
            "extensions": [],
 
66
            "plugin_for": [],
 
67
            "extension_for": [],
 
68
            "module": "ContentHub",
 
69
            "namespace": "",
 
70
            "file": "content-hub.js",
 
71
            "line": 230,
 
72
            "description": "ContentPeer is an object returned by the ContentHub.\n  It represents a remote peer that can be used in a request\n  to import, export or share content.",
 
73
            "is_constructor": 1,
 
74
            "example": [
 
75
                "\n\n      var api = external.getUnityObject('1.0');\n      var hub = api.ContentHub;\n\n      var pictureContentType = hub.ContentType.Pictures;\n\n      hub.defaultSourceForType(\n         pictureContentType\n         , function(peer) {\n            [do something with the peer]\n          });"
 
76
            ]
 
77
        },
 
78
        "ContentStore": {
 
79
            "name": "ContentStore",
 
80
            "shortname": "ContentStore",
 
81
            "classitems": [],
 
82
            "plugins": [],
 
83
            "extensions": [],
 
84
            "plugin_for": [],
 
85
            "extension_for": [],
 
86
            "module": "ContentHub",
 
87
            "namespace": "",
 
88
            "file": "content-hub.js",
 
89
            "line": 456,
 
90
            "description": "ContentStore is an object returned by the ContentHub.\n\n  It represents a location where the resources imported or\n  exported from a peer during a transfer operation are to be\n  either saved or found.",
 
91
            "is_constructor": 1,
 
92
            "example": [
 
93
                "\n\n      var api = external.getUnityObject('1.0');\n      var hub = api.ContentHub;\n\n      var pictureContentType = hub.ContentType.Pictures;\n\n      hub.defaultStoreForType(pictureContentType, function(store) {\n        [do something with the store]\n        });"
 
94
            ]
 
95
        },
 
96
        "ContentHub": {
 
97
            "name": "ContentHub",
 
98
            "shortname": "ContentHub",
 
99
            "classitems": [],
 
100
            "plugins": [],
 
101
            "extensions": [],
 
102
            "plugin_for": [],
 
103
            "extension_for": [],
 
104
            "module": "ContentHub",
 
105
            "namespace": "",
 
106
            "file": "content-hub.js",
 
107
            "line": 568,
 
108
            "description": "The ContentHub object.",
 
109
            "static": 1,
 
110
            "is_constructor": 1
 
111
        }
 
112
    },
 
113
    "classitems": [
 
114
        {
 
115
            "file": "content-hub.js",
 
116
            "line": 64,
 
117
            "description": "Retrieves the current store.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
118
            "itemtype": "method",
 
119
            "name": "store",
 
120
            "params": [
 
121
                {
 
122
                    "name": "callback",
 
123
                    "description": "(optional)",
 
124
                    "type": "Function(String)"
 
125
                }
 
126
            ],
 
127
            "class": "ContentTransfer",
 
128
            "module": "ContentHub"
 
129
        },
 
130
        {
 
131
            "file": "content-hub.js",
 
132
            "line": 79,
 
133
            "description": "Sets the current store for the ContentTransfer.",
 
134
            "itemtype": "method",
 
135
            "name": "setStore",
 
136
            "params": [
 
137
                {
 
138
                    "name": "store",
 
139
                    "description": "",
 
140
                    "type": "ContentStore"
 
141
                },
 
142
                {
 
143
                    "name": "callback",
 
144
                    "description": "(optional)  called when the store has been updated",
 
145
                    "type": "Function()"
 
146
                }
 
147
            ],
 
148
            "class": "ContentTransfer",
 
149
            "module": "ContentHub"
 
150
        },
 
151
        {
 
152
            "file": "content-hub.js",
 
153
            "line": 90,
 
154
            "description": "Retrieves the current state.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
155
            "itemtype": "method",
 
156
            "name": "state",
 
157
            "params": [
 
158
                {
 
159
                    "name": "callback",
 
160
                    "description": "(optional)",
 
161
                    "type": "Function(ContentTransfer.State)"
 
162
                }
 
163
            ],
 
164
            "class": "ContentTransfer",
 
165
            "module": "ContentHub"
 
166
        },
 
167
        {
 
168
            "file": "content-hub.js",
 
169
            "line": 105,
 
170
            "description": "Sets the state of the transfer.",
 
171
            "itemtype": "method",
 
172
            "name": "setState",
 
173
            "params": [
 
174
                {
 
175
                    "name": "state",
 
176
                    "description": "",
 
177
                    "type": "ContentTransfer.State"
 
178
                },
 
179
                {
 
180
                    "name": "callback",
 
181
                    "description": "called when the state has been updated",
 
182
                    "type": "Function()"
 
183
                }
 
184
            ],
 
185
            "class": "ContentTransfer",
 
186
            "module": "ContentHub"
 
187
        },
 
188
        {
 
189
            "file": "content-hub.js",
 
190
            "line": 115,
 
191
            "description": "Notifies the listener when the state of the transfer changes.",
 
192
            "itemtype": "method",
 
193
            "name": "onStateChanged",
 
194
            "params": [
 
195
                {
 
196
                    "name": "callback",
 
197
                    "description": "",
 
198
                    "type": "Function(ContentTransfer.State)"
 
199
                }
 
200
            ],
 
201
            "class": "ContentTransfer",
 
202
            "module": "ContentHub"
 
203
        },
 
204
        {
 
205
            "file": "content-hub.js",
 
206
            "line": 125,
 
207
            "description": "Retrieves the current selection type.",
 
208
            "itemtype": "method",
 
209
            "name": "selectionType",
 
210
            "params": [
 
211
                {
 
212
                    "name": "callback",
 
213
                    "description": "",
 
214
                    "type": "Function(ContentTransfer.SelectionType)"
 
215
                }
 
216
            ],
 
217
            "class": "ContentTransfer",
 
218
            "module": "ContentHub"
 
219
        },
 
220
        {
 
221
            "file": "content-hub.js",
 
222
            "line": 138,
 
223
            "description": "Sets the selection type (single or multiple).",
 
224
            "itemtype": "method",
 
225
            "name": "setSelectionType",
 
226
            "params": [
 
227
                {
 
228
                    "name": "selectionType",
 
229
                    "description": "",
 
230
                    "type": "ContentTransfer.SelectionType"
 
231
                },
 
232
                {
 
233
                    "name": "callback",
 
234
                    "description": "called when the state has been updated",
 
235
                    "type": "Function()"
 
236
                }
 
237
            ],
 
238
            "class": "ContentTransfer",
 
239
            "module": "ContentHub"
 
240
        },
 
241
        {
 
242
            "file": "content-hub.js",
 
243
            "line": 150,
 
244
            "description": "Retrieves the current transfer direction.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
245
            "itemtype": "method",
 
246
            "name": "direction",
 
247
            "params": [
 
248
                {
 
249
                    "name": "callback",
 
250
                    "description": "(optional)",
 
251
                    "type": "Function(ContentTransfer.Direction)"
 
252
                }
 
253
            ],
 
254
            "class": "ContentTransfer",
 
255
            "module": "ContentHub"
 
256
        },
 
257
        {
 
258
            "file": "content-hub.js",
 
259
            "line": 165,
 
260
            "description": "Sets the transfer direction (import or export).",
 
261
            "itemtype": "method",
 
262
            "name": "setDirection",
 
263
            "params": [
 
264
                {
 
265
                    "name": "direction",
 
266
                    "description": "",
 
267
                    "type": "ContentTransfer.Direction"
 
268
                },
 
269
                {
 
270
                    "name": "callback",
 
271
                    "description": "called when the state has been updated",
 
272
                    "type": "Function()"
 
273
                }
 
274
            ],
 
275
            "class": "ContentTransfer",
 
276
            "module": "ContentHub"
 
277
        },
 
278
        {
 
279
            "file": "content-hub.js",
 
280
            "line": 177,
 
281
            "description": "Retrieves the list of items associated with the ContentTransfer.",
 
282
            "itemtype": "method",
 
283
            "name": "items",
 
284
            "params": [
 
285
                {
 
286
                    "name": "callback",
 
287
                    "description": "} )}",
 
288
                    "type": "Function( Objectname: , url:"
 
289
                }
 
290
            ],
 
291
            "class": "ContentTransfer",
 
292
            "module": "ContentHub"
 
293
        },
 
294
        {
 
295
            "file": "content-hub.js",
 
296
            "line": 186,
 
297
            "description": "Sets the list of items for the associated ContentTransfer (used when exporting).",
 
298
            "itemtype": "method",
 
299
            "name": "setItems",
 
300
            "params": [
 
301
                {
 
302
                    "name": "items",
 
303
                    "description": "}",
 
304
                    "type": "Array of Objectname: String, url: String"
 
305
                },
 
306
                {
 
307
                    "name": "callback",
 
308
                    "description": "called when the state has been updated",
 
309
                    "type": "Function()"
 
310
                }
 
311
            ],
 
312
            "class": "ContentTransfer",
 
313
            "module": "ContentHub"
 
314
        },
 
315
        {
 
316
            "file": "content-hub.js",
 
317
            "line": 199,
 
318
            "description": "Starts a transfer",
 
319
            "itemtype": "method",
 
320
            "name": "start",
 
321
            "params": [
 
322
                {
 
323
                    "name": "callback",
 
324
                    "description": "",
 
325
                    "type": "Function(ContentTransfer.State)"
 
326
                }
 
327
            ],
 
328
            "class": "ContentTransfer",
 
329
            "module": "ContentHub"
 
330
        },
 
331
        {
 
332
            "file": "content-hub.js",
 
333
            "line": 209,
 
334
            "description": "Sets State to ContentTransfer.Finalized and cleans up temporary files.",
 
335
            "itemtype": "method",
 
336
            "name": "finalize",
 
337
            "class": "ContentTransfer",
 
338
            "module": "ContentHub"
 
339
        },
 
340
        {
 
341
            "file": "content-hub.js",
 
342
            "line": 220,
 
343
            "description": "Destroys the remote object. This proxy object is not valid anymore.",
 
344
            "itemtype": "method",
 
345
            "name": "destroy",
 
346
            "class": "ContentTransfer",
 
347
            "module": "ContentHub"
 
348
        },
 
349
        {
 
350
            "file": "content-hub.js",
 
351
            "line": 281,
 
352
            "description": "Retrieves the app Id of the associated peer.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
353
            "itemtype": "method",
 
354
            "name": "appId",
 
355
            "return": {
 
356
                "description": "Application Id for this peer",
 
357
                "type": "String"
 
358
            },
 
359
            "params": [
 
360
                {
 
361
                    "name": "callback",
 
362
                    "description": "(optional)",
 
363
                    "type": "Function(String)"
 
364
                }
 
365
            ],
 
366
            "class": "ContentPeer",
 
367
            "module": "ContentHub"
 
368
        },
 
369
        {
 
370
            "file": "content-hub.js",
 
371
            "line": 297,
 
372
            "description": "Sets the app Id of the associated peer.",
 
373
            "itemtype": "method",
 
374
            "name": "setAppId",
 
375
            "params": [
 
376
                {
 
377
                    "name": "appId",
 
378
                    "description": "",
 
379
                    "type": "String"
 
380
                },
 
381
                {
 
382
                    "name": "callback",
 
383
                    "description": "called when the appId has been updated",
 
384
                    "type": "Function()"
 
385
                }
 
386
            ],
 
387
            "class": "ContentPeer",
 
388
            "module": "ContentHub"
 
389
        },
 
390
        {
 
391
            "file": "content-hub.js",
 
392
            "line": 308,
 
393
            "description": "Retrieves the specific ContentHandler for this peer.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
394
            "itemtype": "method",
 
395
            "name": "handler",
 
396
            "return": {
 
397
                "description": "ContentHandler for this peer",
 
398
                "type": "String"
 
399
            },
 
400
            "params": [
 
401
                {
 
402
                    "name": "callback",
 
403
                    "description": "(optional)",
 
404
                    "type": "Function(String)"
 
405
                }
 
406
            ],
 
407
            "class": "ContentPeer",
 
408
            "module": "ContentHub"
 
409
        },
 
410
        {
 
411
            "file": "content-hub.js",
 
412
            "line": 324,
 
413
            "description": "Sets specific ContentHandler for this peer.",
 
414
            "itemtype": "method",
 
415
            "name": "setHandler",
 
416
            "params": [
 
417
                {
 
418
                    "name": "handler",
 
419
                    "description": "",
 
420
                    "type": "ContentHandler"
 
421
                },
 
422
                {
 
423
                    "name": "callback",
 
424
                    "description": "called when the appId has been updated",
 
425
                    "type": "Function()"
 
426
                }
 
427
            ],
 
428
            "class": "ContentPeer",
 
429
            "module": "ContentHub"
 
430
        },
 
431
        {
 
432
            "file": "content-hub.js",
 
433
            "line": 335,
 
434
            "description": "Retrieves the specific ContentType for this peer.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
435
            "itemtype": "method",
 
436
            "name": "contentType",
 
437
            "return": {
 
438
                "description": "ContentType for this peer",
 
439
                "type": "String"
 
440
            },
 
441
            "params": [
 
442
                {
 
443
                    "name": "callback",
 
444
                    "description": "(optional)",
 
445
                    "type": "Function(String)"
 
446
                }
 
447
            ],
 
448
            "class": "ContentPeer",
 
449
            "module": "ContentHub"
 
450
        },
 
451
        {
 
452
            "file": "content-hub.js",
 
453
            "line": 351,
 
454
            "description": "Sets specific ContentType for this peer.",
 
455
            "itemtype": "method",
 
456
            "name": "setContentType",
 
457
            "params": [
 
458
                {
 
459
                    "name": "contentType",
 
460
                    "description": "",
 
461
                    "type": "ContentType"
 
462
                },
 
463
                {
 
464
                    "name": "callback",
 
465
                    "description": "called when the content type has been updated",
 
466
                    "type": "Function()"
 
467
                }
 
468
            ],
 
469
            "class": "ContentPeer",
 
470
            "module": "ContentHub"
 
471
        },
 
472
        {
 
473
            "file": "content-hub.js",
 
474
            "line": 362,
 
475
            "description": "Retrieves the specific SelectionType for this peer.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
476
            "itemtype": "method",
 
477
            "name": "selectionType",
 
478
            "return": {
 
479
                "description": "ContentTransfer.SelectionType for this peer",
 
480
                "type": "String"
 
481
            },
 
482
            "params": [
 
483
                {
 
484
                    "name": "callback",
 
485
                    "description": "(optional)",
 
486
                    "type": "Function(String)"
 
487
                }
 
488
            ],
 
489
            "class": "ContentPeer",
 
490
            "module": "ContentHub"
 
491
        },
 
492
        {
 
493
            "file": "content-hub.js",
 
494
            "line": 378,
 
495
            "description": "Sets specific SelectionType for this peer.",
 
496
            "itemtype": "method",
 
497
            "name": "setSelectionType",
 
498
            "params": [
 
499
                {
 
500
                    "name": "selectionType",
 
501
                    "description": "",
 
502
                    "type": "ContentTransfer.SelectionType"
 
503
                },
 
504
                {
 
505
                    "name": "callback",
 
506
                    "description": "called when the content type has been updated",
 
507
                    "type": "Function()"
 
508
                }
 
509
            ],
 
510
            "class": "ContentPeer",
 
511
            "module": "ContentHub"
 
512
        },
 
513
        {
 
514
            "file": "content-hub.js",
 
515
            "line": 389,
 
516
            "description": "Retrieves the name of the associated peer.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
517
            "itemtype": "method",
 
518
            "name": "name",
 
519
            "params": [
 
520
                {
 
521
                    "name": "callback",
 
522
                    "description": "(optional)",
 
523
                    "type": "Function(String)"
 
524
                }
 
525
            ],
 
526
            "class": "ContentPeer",
 
527
            "module": "ContentHub"
 
528
        },
 
529
        {
 
530
            "file": "content-hub.js",
 
531
            "line": 405,
 
532
            "description": "Returns true if the peer is a default one, false otherwise.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
533
            "itemtype": "method",
 
534
            "name": "isDefaultPeer",
 
535
            "params": [
 
536
                {
 
537
                    "name": "callback",
 
538
                    "description": "(optional)",
 
539
                    "type": "Function(Bool)"
 
540
                }
 
541
            ],
 
542
            "class": "ContentPeer",
 
543
            "module": "ContentHub"
 
544
        },
 
545
        {
 
546
            "file": "content-hub.js",
 
547
            "line": 423,
 
548
            "description": "Request to exchange content with this ContentPeer.",
 
549
            "itemtype": "method",
 
550
            "name": "request",
 
551
            "params": [
 
552
                {
 
553
                    "name": "callback",
 
554
                    "description": "Called with the resulting content transfer",
 
555
                    "type": "Function(ContentTransfer)"
 
556
                }
 
557
            ],
 
558
            "class": "ContentPeer",
 
559
            "module": "ContentHub"
 
560
        },
 
561
        {
 
562
            "file": "content-hub.js",
 
563
            "line": 433,
 
564
            "description": "Request to import content from this ContentPeer and use a ContentStore for permanent storage.",
 
565
            "itemtype": "method",
 
566
            "name": "requestForStore",
 
567
            "params": [
 
568
                {
 
569
                    "name": "store",
 
570
                    "description": "Store used as a permanent storage",
 
571
                    "type": "ContentStore"
 
572
                },
 
573
                {
 
574
                    "name": "callback",
 
575
                    "description": "Called with the resulting content transfer",
 
576
                    "type": "Function(ContentTransfer)"
 
577
                }
 
578
            ],
 
579
            "class": "ContentPeer",
 
580
            "module": "ContentHub"
 
581
        },
 
582
        {
 
583
            "file": "content-hub.js",
 
584
            "line": 446,
 
585
            "description": "Destroys the remote object. This proxy object is not valid anymore.",
 
586
            "itemtype": "method",
 
587
            "name": "destroy",
 
588
            "class": "ContentPeer",
 
589
            "module": "ContentHub"
 
590
        },
 
591
        {
 
592
            "file": "content-hub.js",
 
593
            "line": 501,
 
594
            "description": "Retrieves the uri of the associated store.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
595
            "itemtype": "method",
 
596
            "name": "uri",
 
597
            "return": {
 
598
                "description": "current uri",
 
599
                "type": "String"
 
600
            },
 
601
            "params": [
 
602
                {
 
603
                    "name": "callback",
 
604
                    "description": "(optional)",
 
605
                    "type": "Function(String)"
 
606
                }
 
607
            ],
 
608
            "class": "ContentStore",
 
609
            "module": "ContentHub"
 
610
        },
 
611
        {
 
612
            "file": "content-hub.js",
 
613
            "line": 518,
 
614
            "description": "Retrieves the current scope.\n\nIf the callback parameter is not set, the current \"local\" value is retrieved.",
 
615
            "itemtype": "method",
 
616
            "name": "scope",
 
617
            "return": {
 
618
                "description": "current scope",
 
619
                "type": "ContentScope"
 
620
            },
 
621
            "params": [
 
622
                {
 
623
                    "name": "callback",
 
624
                    "description": "(optional)",
 
625
                    "type": "Function(ContentScope)"
 
626
                }
 
627
            ],
 
628
            "class": "ContentStore",
 
629
            "module": "ContentHub"
 
630
        },
 
631
        {
 
632
            "file": "content-hub.js",
 
633
            "line": 534,
 
634
            "description": "Sets the current scope.",
 
635
            "itemtype": "method",
 
636
            "name": "setScope",
 
637
            "params": [
 
638
                {
 
639
                    "name": "scope",
 
640
                    "description": "",
 
641
                    "type": "ContentScope"
 
642
                },
 
643
                {
 
644
                    "name": "callback",
 
645
                    "description": "called when the scope has been updated",
 
646
                    "type": "Function()"
 
647
                }
 
648
            ],
 
649
            "class": "ContentStore",
 
650
            "module": "ContentHub"
 
651
        },
 
652
        {
 
653
            "file": "content-hub.js",
 
654
            "line": 547,
 
655
            "description": "Destroys the remote object. This proxy object is not valid anymore.",
 
656
            "itemtype": "method",
 
657
            "name": "destroy",
 
658
            "class": "ContentStore",
 
659
            "module": "ContentHub"
 
660
        },
 
661
        {
 
662
            "file": "content-hub.js",
 
663
            "line": 576,
 
664
            "description": "ContentType is an enumeration of well known content types.\n\n  Values:\n\n    Pictures\n\n    Documents\n    \n    Music\n\n    Contacts\n\n    Videos\n\n    Links",
 
665
            "static": 1,
 
666
            "itemtype": "property",
 
667
            "name": "ContentType",
 
668
            "type": "String",
 
669
            "example": [
 
670
                "\n\n var api = external.getUnityObject('1.0');\n var hub = api.ContentHub;\n\n var pictureContentType = hub.ContentType.Pictures;"
 
671
            ],
 
672
            "class": "ContentHub",
 
673
            "module": "ContentHub"
 
674
        },
 
675
        {
 
676
            "file": "content-hub.js",
 
677
            "line": 614,
 
678
            "description": "ContentHandler is an enumeration of well known content handlers.\n\n Values:\n\n   Source\n\n   Destination\n\n   Share",
 
679
            "static": 1,
 
680
            "itemtype": "property",
 
681
            "name": "ContentHandler",
 
682
            "type": "String",
 
683
            "class": "ContentHub",
 
684
            "module": "ContentHub"
 
685
        },
 
686
        {
 
687
            "file": "content-hub.js",
 
688
            "line": 634,
 
689
            "description": "ContentScope is an enumeration of well known scope types.\n\n Values:\n\n   System\n\n   User\n\n   App",
 
690
            "static": 1,
 
691
            "itemtype": "property",
 
692
            "name": "ContentScope",
 
693
            "type": "String",
 
694
            "class": "ContentHub",
 
695
            "module": "ContentHub"
 
696
        },
 
697
        {
 
698
            "file": "content-hub.js",
 
699
            "line": 656,
 
700
            "description": "ContentTransfer.State is an enumeration of the state of a given ongoing ContentTransfer.\n\n  Values:\n\n   Created: Transfer created, waiting to be initiated.\n\n   Initiated: Transfer has been initiated.\n\n   InProgress: Transfer is in progress.\n\n   Charged: Transfer is charged with items and ready to be collected.\n\n   Collected: Items in the transfer have been collected.\n\n   Aborted: Transfer has been aborted.\n\n   Finalized: Transfer has been finished and cleaned up.\n\n   Downloaded: Download specified by downloadId has completed.\n\n   Downloading: Transfer is downloading item specified by downloadId.",
 
701
            "static": 1,
 
702
            "itemtype": "property",
 
703
            "name": "ContentTransfer.State",
 
704
            "type": "String",
 
705
            "example": [
 
706
                "\n\n var api = external.getUnityObject('1.0');\n var hub = api.ContentHub;\n\n var transferState = hub.ContentTransfer.State;\n var pictureContentType = hub.ContentType.Pictures;\n\n hub.importContentForPeer(\n   pictureContentType,\n   peer,\n   function(transfer) {\n       hub.defaultStoreForType(pictureContentType, function(store) {\n           transfer.setStore(store, function() {\n               transfer.start(function(state) {\n                   if (transferState.Aborted === state) {\n                     [...]\n                   }\n                   [...]\n               });\n           });\n       });\n });\n"
 
707
            ],
 
708
            "class": "ContentHub",
 
709
            "module": "ContentHub"
 
710
        },
 
711
        {
 
712
            "file": "content-hub.js",
 
713
            "line": 736,
 
714
            "description": "ContentTransfer.Direction is an enumeration of the directions of a given ContentTransfer.\n\n  Values:\n\n   Import\n\n   Export\n\n   Share",
 
715
            "static": 1,
 
716
            "itemtype": "property",
 
717
            "name": "ContentTransfer.Direction",
 
718
            "type": "String",
 
719
            "class": "ContentHub",
 
720
            "module": "ContentHub"
 
721
        },
 
722
        {
 
723
            "file": "content-hub.js",
 
724
            "line": 761,
 
725
            "description": "ContentTransfer.SelectionType is an enumeration of the directions of a given ContentTransfer.\n\n  Values:\n\n   Single: Transfer should contain a single item\n\n   Multiple: Transfer can contain multiple items",
 
726
            "static": 1,
 
727
            "itemtype": "property",
 
728
            "name": "ContentTransfer.SelectionType",
 
729
            "type": "String",
 
730
            "class": "ContentHub",
 
731
            "module": "ContentHub"
 
732
        },
 
733
        {
 
734
            "file": "content-hub.js",
 
735
            "line": 782,
 
736
            "description": "Creates a ContentPeer object for the given source type.",
 
737
            "itemtype": "method",
 
738
            "name": "getPeers",
 
739
            "params": [
 
740
                {
 
741
                    "name": "filters",
 
742
                    "description": "A dictionary of parameters to filter the result. The filtering keys are:\n- contentType: desired ContentType\n- handler: desired ContentHandler",
 
743
                    "type": "Object"
 
744
                },
 
745
                {
 
746
                    "name": "callback",
 
747
                    "description": "Callback that receives the result or null",
 
748
                    "type": "Function(List of ContentPeer objects)"
 
749
                }
 
750
            ],
 
751
            "class": "ContentHub",
 
752
            "module": "ContentHub"
 
753
        },
 
754
        {
 
755
            "file": "content-hub.js",
 
756
            "line": 798,
 
757
            "description": "Creates a ContentStore object for the given scope type.",
 
758
            "itemtype": "method",
 
759
            "name": "getStore",
 
760
            "params": [
 
761
                {
 
762
                    "name": "scope",
 
763
                    "description": "The content scope for the store",
 
764
                    "type": "ContentScope"
 
765
                },
 
766
                {
 
767
                    "name": "callback",
 
768
                    "description": "Callback that receives the result or null",
 
769
                    "type": "Function(ContentStore)"
 
770
                }
 
771
            ],
 
772
            "class": "ContentHub",
 
773
            "module": "ContentHub"
 
774
        },
 
775
        {
 
776
            "file": "content-hub.js",
 
777
            "line": 811,
 
778
            "description": "Launches the content peer picker ui that allows the user to select a peer.",
 
779
            "itemtype": "method",
 
780
            "name": "launchContentPeerPicker",
 
781
            "params": [
 
782
                {
 
783
                    "name": "filters",
 
784
                    "description": "A dictionary of parameters to filter the result. The filtering keys are:\n- contentType: desired ContentType\n- handler: desired ContentHandler\n- showTitle: boolean value indicating if the title should be visible",
 
785
                    "type": "Object"
 
786
                },
 
787
                {
 
788
                    "name": "onPeerSelected",
 
789
                    "description": "Called when the user has selected a peer",
 
790
                    "type": "Function(ContentPeer)"
 
791
                },
 
792
                {
 
793
                    "name": "onCancelPressed",
 
794
                    "description": "Called when the user has pressed cancel",
 
795
                    "type": "Function()"
 
796
                }
 
797
            ],
 
798
            "class": "ContentHub",
 
799
            "module": "ContentHub"
 
800
        },
 
801
        {
 
802
            "file": "content-hub.js",
 
803
            "line": 827,
 
804
            "description": "Sets a handler that is to be called when the current application is the\ntarget of an export request.",
 
805
            "itemtype": "method",
 
806
            "name": "onExportRequested",
 
807
            "params": [
 
808
                {
 
809
                    "name": "callback",
 
810
                    "description": "Function when one requests a resource to be exported.\n                                                         The corresponding ContentTransfer is provided as a parameter.",
 
811
                    "type": "Function(ContentTransfer)"
 
812
                }
 
813
            ],
 
814
            "example": [
 
815
                "\n        \n           var api = external.getUnityObject(1.0);\n           var hub = api.ContentHub;\n        \n           var transferState = hub.ContentTransfer.State;\n           \n           function _exportRequested(transfer) {\n             var url = window.location.href;\n             url = url.substr(0, url.lastIndexOf('/')+1) + 'img/ubuntuone-music.png';\n           \n             transfer.setItems([{name: 'Ubuntu One', url: url}],\n               function() {\n                 transfer.setState(hub.ContentTransfer.State.Charged);\n               });\n             };\n           \n           hub.onExportRequested(_exportRequested);\n        "
 
816
            ],
 
817
            "class": "ContentHub",
 
818
            "module": "ContentHub"
 
819
        },
 
820
        {
 
821
            "file": "content-hub.js",
 
822
            "line": 860,
 
823
            "description": "Sets a handler that is to be called when the current application is the\ntarget of an share request.",
 
824
            "itemtype": "method",
 
825
            "name": "onShareRequested",
 
826
            "params": [
 
827
                {
 
828
                    "name": "callback",
 
829
                    "description": "Function when one requests a resource to be shared.\n                                                         The corresponding ContentTransfer is provided as a parameter.",
 
830
                    "type": "Function(ContentTransfer)"
 
831
                }
 
832
            ],
 
833
            "example": [
 
834
                "\n\n           var api = external.getUnityObject(1.0);\n           var hub = api.ContentHub;\n\n           var transferState = hub.ContentTransfer.State;\n\n           function _shareRequested(transfer) {\n           };\n\n           hub.onShareRequested(_shareRequested);\n"
 
835
            ],
 
836
            "class": "ContentHub",
 
837
            "module": "ContentHub"
 
838
        },
 
839
        {
 
840
            "file": "content-hub.js",
 
841
            "line": 886,
 
842
            "description": "Sets a handler that is to be called when the current application is the\ntarget of an import request.",
 
843
            "itemtype": "method",
 
844
            "name": "onImportRequested",
 
845
            "params": [
 
846
                {
 
847
                    "name": "callback",
 
848
                    "description": "Function when one requests a resource to be imported.\n                                                         The corresponding ContentTransfer is provided as a parameter.",
 
849
                    "type": "Function(ContentTransfer)"
 
850
                }
 
851
            ],
 
852
            "example": [
 
853
                "\n\n           var api = external.getUnityObject(1.0);\n           var hub = api.ContentHub;\n\n           var transferState = hub.ContentTransfer.State;\n\n           function _importRequested(transfer) {\n           };\n\n           hub.onImportRequested(_importRequested);\n"
 
854
            ],
 
855
            "class": "ContentHub",
 
856
            "module": "ContentHub"
 
857
        },
 
858
        {
 
859
            "file": "content-hub.js",
 
860
            "line": 914,
 
861
            "description": "Creates a ContentStore object for the given ContentPeer.",
 
862
            "itemtype": "method",
 
863
            "name": "api.importContent",
 
864
            "params": [
 
865
                {
 
866
                    "name": "type",
 
867
                    "description": "type of the content to import",
 
868
                    "type": "ContentType"
 
869
                },
 
870
                {
 
871
                    "name": "peer",
 
872
                    "description": "peer who's content should be imported",
 
873
                    "type": "ContentPeer"
 
874
                },
 
875
                {
 
876
                    "name": "transferOptions",
 
877
                    "description": "a dictionary of transfer options. The options are the following:\n- multipleFiles {Bool}: specified if a transfer should involve multiple files or not\n- scope {ContentScope}: specifies the location where the transferred files should be copied to",
 
878
                    "type": "Object"
 
879
                },
 
880
                {
 
881
                    "name": "onError",
 
882
                    "description": "called when the transfer has failed",
 
883
                    "type": "Function(reason:)"
 
884
                },
 
885
                {
 
886
                    "name": "onSuccess",
 
887
                    "description": ")} called when the transfer has been a success and items are available",
 
888
                    "type": "Function(Array of ContentItem"
 
889
                }
 
890
            ],
 
891
            "class": "ContentHub",
 
892
            "module": "ContentHub"
 
893
        },
 
894
        {
 
895
            "file": "content-hub.js",
 
896
            "line": 934,
 
897
            "access": "private",
 
898
            "tagname": "",
 
899
            "class": "ContentHub",
 
900
            "module": "ContentHub"
 
901
        }
 
902
    ],
 
903
    "warnings": [
 
904
        {
 
905
            "message": "Missing item type",
 
906
            "line": " content-hub.js:934"
 
907
        }
 
908
    ]
 
909
}
 
 
b'\\ No newline at end of file'