unity-js-scopes

Merge lp:~davidc3/unity-js-scopes/regenerate-doc into lp:unity-js-scopes

  1. regenerate-doc
  2. Merge into trunk
Proposed by David Callé
Status: Merged
Approved by: Marcus Tomlinson
Approved revision: 123
Merged at revision: 122
Proposed branch: lp:~davidc3/unity-js-scopes/regenerate-doc
Merge into: lp:unity-js-scopes
Diff against target: 2959 lines (+2847/-8)
6 files modified
doc/docbuild/api.js (+2/-1)
doc/docbuild/assets/js/api-filter.js (+5/-1)
doc/docbuild/assets/js/api-list.js (+6/-2)
doc/docbuild/assets/js/apidocs.js (+7/-1)
doc/docbuild/data.json (+2815/-2)
doc/generate-doc.py (+12/-1)
To merge this branch: bzr merge lp:~davidc3/unity-js-scopes/regenerate-doc
Reviewer Review Type Date Requested Status
Marcus Tomlinson (community) Approve
PS Jenkins bot (community) continuous-integration Approve
Alexandre Abreu (community) Approve
Review via email: mp+281893@code.launchpad.net

Commit message

* Re-generate the documentation using "make doc", to effectively fill "doc/docbuild/data.json" with content that can be extracted by the developer portal.
* Remove file paths in data.json during doc generation

Description of the change

Re-generate the documentation using "make doc", to effectively fill "doc/docbuild/data.json" with content that can be extracted by the developer portal.

To post a comment you must log in.
Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

your doc/docbuild/data.json file is filled with references to local files,

review: Needs Fixing
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:122
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~davidc3/unity-js-scopes/regenerate-doc/+merge/281893/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/69/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/70
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/69

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/69/rebuild

review: Needs Fixing (continuous-integration)
Revision history for this message
David Callé (davidc3) wrote :

Hah, that reminds me of something :)
/me looks into it.

lp:~davidc3/unity-js-scopes/regenerate-doc updated
123. By David Callé

Regex and remove local files references in doc data.json

Revision history for this message
David Callé (davidc3) wrote :

Added a regex to generate-doc.py to only leave file names. File names only is also what can be found in other yuidocs we ship (html-ui-toolkit, unity-webapps-qml, etc.)

Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

+1

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

PASSED: Continuous integration, rev:123
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/70/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/71
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/71
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/71/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/70

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/70/rebuild

review: Approve (continuous-integration)
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Top-approving & merging

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/docbuild/api.js'
2--- doc/docbuild/api.js 2015-10-29 14:21:21 +0000
3+++ doc/docbuild/api.js 2016-01-08 14:42:13 +0000
4@@ -58,6 +58,7 @@
5 "name": "ScopeJS",
6 "description": "Metadata passed to scopes for preview and activation"
7 }
8- ]
9+ ],
10+ "elements": []
11 } };
12 });
13\ No newline at end of file
14
15=== modified file 'doc/docbuild/assets/js/api-filter.js'
16--- doc/docbuild/assets/js/api-filter.js 2015-10-26 22:13:03 +0000
17+++ doc/docbuild/assets/js/api-filter.js 2016-01-08 14:42:13 +0000
18@@ -40,6 +40,10 @@
19 }
20 });
21
22+ if (this.get('queryType') === 'elements') {
23+ name = '<' + name + '>';
24+ }
25+
26 return name;
27 }
28
29@@ -50,7 +54,7 @@
30 value: 'phraseMatch'
31 },
32
33- // May be set to "classes" or "modules".
34+ // May be set to "classes", "elements" or "modules".
35 queryType: {
36 value: 'classes'
37 },
38
39=== modified file 'doc/docbuild/assets/js/api-list.js'
40--- doc/docbuild/assets/js/api-list.js 2015-10-26 22:13:03 +0000
41+++ doc/docbuild/assets/js/api-list.js 2016-01-08 14:42:13 +0000
42@@ -32,6 +32,7 @@
43 APIList = Y.namespace('APIList'),
44
45 classesNode = Y.one('#api-classes'),
46+ elementsNode = Y.one('#api-elements'),
47 inputNode = Y.one('#api-filter'),
48 modulesNode = Y.one('#api-modules'),
49 tabviewNode = Y.one('#api-tabview'),
50@@ -123,7 +124,9 @@
51
52 // -- Private Functions --------------------------------------------------------
53 function getFilterResultNode() {
54- return filter.get('queryType') === 'classes' ? classesNode : modulesNode;
55+ var queryType = filter.get('queryType');
56+ return queryType === 'classes' ? classesNode
57+ : queryType === 'elements' ? elementsNode : modulesNode;
58 }
59
60 // -- Event Handlers -----------------------------------------------------------
61@@ -131,7 +134,7 @@
62 var frag = Y.one(Y.config.doc.createDocumentFragment()),
63 resultNode = getFilterResultNode(),
64 typePlural = filter.get('queryType'),
65- typeSingular = typePlural === 'classes' ? 'class' : 'module';
66+ typeSingular = typePlural === 'classes' ? 'class' : typePlural === 'elements' ? 'element' : 'module';
67
68 if (e.results.length) {
69 YArray.each(e.results, function (result) {
70@@ -207,6 +210,7 @@
71 };
72
73 switch (name) {
74+ case 'elements':// fallthru
75 case 'classes': // fallthru
76 case 'modules':
77 filter.setAttrs({
78
79=== modified file 'doc/docbuild/assets/js/apidocs.js'
80--- doc/docbuild/assets/js/apidocs.js 2015-10-26 22:13:03 +0000
81+++ doc/docbuild/assets/js/apidocs.js 2016-01-08 14:42:13 +0000
82@@ -69,6 +69,12 @@
83 callbacks: defaultRoute
84 },
85
86+ // -- /elements/* -------------------------------------------------------
87+ {
88+ path : '/elements/:element.html*',
89+ callbacks: defaultRoute
90+ },
91+
92 // -- /classes/* -------------------------------------------------------
93 {
94 path : '/classes/:class.html*',
95@@ -193,7 +199,7 @@
96 };
97
98 pjax.initRoot = function () {
99- var terminators = /^(?:classes|files|modules)$/,
100+ var terminators = /^(?:classes|files|elements|modules)$/,
101 parts = pjax._getPathRoot().split('/'),
102 root = [],
103 i, len, part;
104
105=== modified file 'doc/docbuild/data.json'
106--- doc/docbuild/data.json 2015-12-16 16:55:11 +0000
107+++ doc/docbuild/data.json 2016-01-08 14:42:13 +0000
108@@ -4,5 +4,2818 @@
109 "description": "Javascript API for Ubuntu Scopes development",
110 "version": "0.1"
111 },
112- "warnings": []
113-}
114+ "files": {
115+ "action-metadata.js": {
116+ "name": "action-metadata.js",
117+ "modules": {
118+ "ScopeJS": 1
119+ },
120+ "classes": {
121+ "ActionMetadata": 1
122+ },
123+ "fors": {},
124+ "namespaces": {}
125+ },
126+ "activation-query.js": {
127+ "name": "activation-query.js",
128+ "modules": {},
129+ "classes": {
130+ "ActivationQuery": 1
131+ },
132+ "fors": {},
133+ "namespaces": {}
134+ },
135+ "categorised-result.js": {
136+ "name": "categorised-result.js",
137+ "modules": {},
138+ "classes": {
139+ "CategorisedResult": 1
140+ },
141+ "fors": {},
142+ "namespaces": {}
143+ },
144+ "category-renderer.js": {
145+ "name": "category-renderer.js",
146+ "modules": {},
147+ "classes": {
148+ "CategoryRenderer": 1
149+ },
150+ "fors": {},
151+ "namespaces": {}
152+ },
153+ "category.js": {
154+ "name": "category.js",
155+ "modules": {},
156+ "classes": {
157+ "Category": 1
158+ },
159+ "fors": {},
160+ "namespaces": {}
161+ },
162+ "column-layout.js": {
163+ "name": "column-layout.js",
164+ "modules": {},
165+ "classes": {
166+ "ColumnLayout": 1
167+ },
168+ "fors": {},
169+ "namespaces": {}
170+ },
171+ "department.js": {
172+ "name": "department.js",
173+ "modules": {},
174+ "classes": {
175+ "Department": 1
176+ },
177+ "fors": {},
178+ "namespaces": {}
179+ },
180+ "filter-option.js": {
181+ "name": "filter-option.js",
182+ "modules": {},
183+ "classes": {},
184+ "fors": {},
185+ "namespaces": {}
186+ },
187+ "filter-state.js": {
188+ "name": "filter-state.js",
189+ "modules": {},
190+ "classes": {
191+ "FilterOption": 1
192+ },
193+ "fors": {},
194+ "namespaces": {}
195+ },
196+ "online-account-client-service-status.js": {
197+ "name": "online-account-client-service-status.js",
198+ "modules": {},
199+ "classes": {
200+ "OnlineAccountClientServiceStatus": 1
201+ },
202+ "fors": {},
203+ "namespaces": {}
204+ },
205+ "online-account-client.js": {
206+ "name": "online-account-client.js",
207+ "modules": {},
208+ "classes": {
209+ "OnlineAccountClient": 1
210+ },
211+ "fors": {},
212+ "namespaces": {}
213+ },
214+ "option-selector-filter.js": {
215+ "name": "option-selector-filter.js",
216+ "modules": {},
217+ "classes": {
218+ "OptionSelectorFilter": 1
219+ },
220+ "fors": {},
221+ "namespaces": {}
222+ },
223+ "preview-query.js": {
224+ "name": "preview-query.js",
225+ "modules": {},
226+ "classes": {
227+ "PreviewQuery": 1
228+ },
229+ "fors": {},
230+ "namespaces": {}
231+ },
232+ "preview-reply.js": {
233+ "name": "preview-reply.js",
234+ "modules": {},
235+ "classes": {
236+ "PreviewReply": 1
237+ },
238+ "fors": {},
239+ "namespaces": {}
240+ },
241+ "preview-widget.js": {
242+ "name": "preview-widget.js",
243+ "modules": {},
244+ "classes": {
245+ "PreviewWidget": 1
246+ },
247+ "fors": {},
248+ "namespaces": {}
249+ },
250+ "registry.js": {
251+ "name": "registry.js",
252+ "modules": {},
253+ "classes": {
254+ "Registry": 1
255+ },
256+ "fors": {},
257+ "namespaces": {}
258+ },
259+ "result.js": {
260+ "name": "result.js",
261+ "modules": {},
262+ "classes": {
263+ "Result": 1
264+ },
265+ "fors": {},
266+ "namespaces": {}
267+ },
268+ "scope-metadata.js": {
269+ "name": "scope-metadata.js",
270+ "modules": {},
271+ "classes": {
272+ "ScopeMetadata": 1
273+ },
274+ "fors": {},
275+ "namespaces": {}
276+ },
277+ "search-metadata.js": {
278+ "name": "search-metadata.js",
279+ "modules": {},
280+ "classes": {
281+ "SearchMetadata": 1
282+ },
283+ "fors": {},
284+ "namespaces": {}
285+ },
286+ "search-query.js": {
287+ "name": "search-query.js",
288+ "modules": {},
289+ "classes": {
290+ "SearchQuery": 1
291+ },
292+ "fors": {},
293+ "namespaces": {}
294+ },
295+ "search-reply.js": {
296+ "name": "search-reply.js",
297+ "modules": {},
298+ "classes": {
299+ "SearchReply": 1
300+ },
301+ "fors": {},
302+ "namespaces": {}
303+ },
304+ "index.js": {
305+ "name": "index.js",
306+ "modules": {},
307+ "classes": {
308+ "Scope": 1
309+ },
310+ "fors": {},
311+ "namespaces": {}
312+ }
313+ },
314+ "modules": {
315+ "ScopeJS": {
316+ "name": "ScopeJS",
317+ "submodules": {},
318+ "elements": {},
319+ "classes": {
320+ "ActionMetadata": 1,
321+ "ActivationQuery": 1,
322+ "CategorisedResult": 1,
323+ "CategoryRenderer": 1,
324+ "Category": 1,
325+ "ColumnLayout": 1,
326+ "Department": 1,
327+ "FilterOption": 1,
328+ "OnlineAccountClientServiceStatus": 1,
329+ "OnlineAccountClient": 1,
330+ "OptionSelectorFilter": 1,
331+ "PreviewQuery": 1,
332+ "PreviewReply": 1,
333+ "PreviewWidget": 1,
334+ "Registry": 1,
335+ "Result": 1,
336+ "ScopeMetadata": 1,
337+ "SearchMetadata": 1,
338+ "SearchQuery": 1,
339+ "SearchReply": 1,
340+ "Scope": 1
341+ },
342+ "fors": {},
343+ "namespaces": {},
344+ "tag": "module",
345+ "file": "index.js",
346+ "line": 25,
347+ "description": "Metadata passed to scopes for preview and activation",
348+ "is_constructor": 1,
349+ "params": [
350+ {
351+ "name": "query",
352+ "description": "query associated with the Department",
353+ "type": "CannedQuery"
354+ }
355+ ],
356+ "example": [
357+ "\n\n var scopes = require('unity-js-scopes')\n function on_preview(result, action_metadata) {\n return new scopes.lib.preview_query(\n result,\n action_metadata,\n // run\n function(preview_reply) {},\n // cancelled\n function() {});\n }\n scopes.self.initialize(\n {}\n ,\n {\n run: function() { },\n start: function(scope_id) { },\n preview: on_preview,\n }\n );"
358+ ]
359+ }
360+ },
361+ "classes": {
362+ "ActionMetadata": {
363+ "name": "ActionMetadata",
364+ "shortname": "ActionMetadata",
365+ "classitems": [],
366+ "plugins": [],
367+ "extensions": [],
368+ "plugin_for": [],
369+ "extension_for": [],
370+ "module": "ScopeJS",
371+ "namespace": "",
372+ "file": "action-metadata.js",
373+ "line": 1,
374+ "description": "Metadata passed to scopes for preview and activation"
375+ },
376+ "ActivationQuery": {
377+ "name": "ActivationQuery",
378+ "shortname": "ActivationQuery",
379+ "classitems": [],
380+ "plugins": [],
381+ "extensions": [],
382+ "plugin_for": [],
383+ "extension_for": [],
384+ "module": "ScopeJS",
385+ "namespace": "",
386+ "file": "activation-query.js",
387+ "line": 1,
388+ "description": "Represents an activation request that is executed inside a scope"
389+ },
390+ "CategorisedResult": {
391+ "name": "CategorisedResult",
392+ "shortname": "CategorisedResult",
393+ "classitems": [],
394+ "plugins": [],
395+ "extensions": [],
396+ "plugin_for": [],
397+ "extension_for": [],
398+ "module": "ScopeJS",
399+ "namespace": "",
400+ "file": "categorised-result.js",
401+ "line": 1,
402+ "description": "A result, including the category it belongs to."
403+ },
404+ "CategoryRenderer": {
405+ "name": "CategoryRenderer",
406+ "shortname": "CategoryRenderer",
407+ "classitems": [],
408+ "plugins": [],
409+ "extensions": [],
410+ "plugin_for": [],
411+ "extension_for": [],
412+ "module": "ScopeJS",
413+ "namespace": "",
414+ "file": "category-renderer.js",
415+ "line": 1,
416+ "description": "A category renderer template in JSON format."
417+ },
418+ "Category": {
419+ "name": "Category",
420+ "shortname": "Category",
421+ "classitems": [],
422+ "plugins": [],
423+ "extensions": [],
424+ "plugin_for": [],
425+ "extension_for": [],
426+ "module": "ScopeJS",
427+ "namespace": "",
428+ "file": "category.js",
429+ "line": 1,
430+ "description": "A set of related results returned by a scope\n and displayed within a single pane in the Unity dash.\nTo create a Category, use SearchReply.register_category."
431+ },
432+ "ColumnLayout": {
433+ "name": "ColumnLayout",
434+ "shortname": "ColumnLayout",
435+ "classitems": [],
436+ "plugins": [],
437+ "extensions": [],
438+ "plugin_for": [],
439+ "extension_for": [],
440+ "module": "ScopeJS",
441+ "namespace": "",
442+ "file": "column-layout.js",
443+ "line": 1,
444+ "description": "Describes a column layout for preview widgets."
445+ },
446+ "Department": {
447+ "name": "Department",
448+ "shortname": "Department",
449+ "classitems": [],
450+ "plugins": [],
451+ "extensions": [],
452+ "plugin_for": [],
453+ "extension_for": [],
454+ "module": "ScopeJS",
455+ "namespace": "",
456+ "file": "department.js",
457+ "line": 1,
458+ "description": "A department with optional sub-department"
459+ },
460+ "FilterOption": {
461+ "name": "FilterOption",
462+ "shortname": "FilterOption",
463+ "classitems": [],
464+ "plugins": [],
465+ "extensions": [],
466+ "plugin_for": [],
467+ "extension_for": [],
468+ "module": "ScopeJS",
469+ "namespace": "",
470+ "file": "filter-state.js",
471+ "line": 1,
472+ "description": "Captures state of multiple filters."
473+ },
474+ "OnlineAccountClientServiceStatus": {
475+ "name": "OnlineAccountClientServiceStatus",
476+ "shortname": "OnlineAccountClientServiceStatus",
477+ "classitems": [],
478+ "plugins": [],
479+ "extensions": [],
480+ "plugin_for": [],
481+ "extension_for": [],
482+ "module": "ScopeJS",
483+ "namespace": "",
484+ "file": "online-account-client-service-status.js",
485+ "line": 1,
486+ "description": "An object that contains the details about a service's status and authorization parameters"
487+ },
488+ "OnlineAccountClient": {
489+ "name": "OnlineAccountClient",
490+ "shortname": "OnlineAccountClient",
491+ "classitems": [],
492+ "plugins": [],
493+ "extensions": [],
494+ "plugin_for": [],
495+ "extension_for": [],
496+ "module": "ScopeJS",
497+ "namespace": "",
498+ "file": "online-account-client.js",
499+ "line": 1,
500+ "description": "A simple interface for integrating online accounts access and monitoring into scopes."
501+ },
502+ "OptionSelectorFilter": {
503+ "name": "OptionSelectorFilter",
504+ "shortname": "OptionSelectorFilter",
505+ "classitems": [],
506+ "plugins": [],
507+ "extensions": [],
508+ "plugin_for": [],
509+ "extension_for": [],
510+ "module": "ScopeJS",
511+ "namespace": "",
512+ "file": "option-selector-filter.js",
513+ "line": 1,
514+ "description": "A selection filter that displays a list of choices and allows one or more of them to be selected"
515+ },
516+ "PreviewQuery": {
517+ "name": "PreviewQuery",
518+ "shortname": "PreviewQuery",
519+ "classitems": [],
520+ "plugins": [],
521+ "extensions": [],
522+ "plugin_for": [],
523+ "extension_for": [],
524+ "module": "ScopeJS",
525+ "namespace": "",
526+ "file": "preview-query.js",
527+ "line": 1,
528+ "description": "Represents a particular preview"
529+ },
530+ "PreviewReply": {
531+ "name": "PreviewReply",
532+ "shortname": "PreviewReply",
533+ "classitems": [],
534+ "plugins": [],
535+ "extensions": [],
536+ "plugin_for": [],
537+ "extension_for": [],
538+ "module": "ScopeJS",
539+ "namespace": "",
540+ "file": "preview-reply.js",
541+ "line": 1,
542+ "description": "Allows the results of a preview to be sent to the preview requester."
543+ },
544+ "PreviewWidget": {
545+ "name": "PreviewWidget",
546+ "shortname": "PreviewWidget",
547+ "classitems": [],
548+ "plugins": [],
549+ "extensions": [],
550+ "plugin_for": [],
551+ "extension_for": [],
552+ "module": "ScopeJS",
553+ "namespace": "",
554+ "file": "preview-widget.js",
555+ "line": 1,
556+ "description": "A widget for a preview."
557+ },
558+ "Registry": {
559+ "name": "Registry",
560+ "shortname": "Registry",
561+ "classitems": [],
562+ "plugins": [],
563+ "extensions": [],
564+ "plugin_for": [],
565+ "extension_for": [],
566+ "module": "ScopeJS",
567+ "namespace": "",
568+ "file": "registry.js",
569+ "line": 1,
570+ "description": "White pages service for available scopes"
571+ },
572+ "Result": {
573+ "name": "Result",
574+ "shortname": "Result",
575+ "classitems": [],
576+ "plugins": [],
577+ "extensions": [],
578+ "plugin_for": [],
579+ "extension_for": [],
580+ "module": "ScopeJS",
581+ "namespace": "",
582+ "file": "result.js",
583+ "line": 1,
584+ "description": "The attributes of a result returned by a Scope\nThe Result API provides convenience methods for some typical attributes (title, art), but scopes are free to add and use any custom attributes with set/get methods. The only required attribute is 'uri' and it must not be empty before calling Reply.push()."
585+ },
586+ "ScopeMetadata": {
587+ "name": "ScopeMetadata",
588+ "shortname": "ScopeMetadata",
589+ "classitems": [],
590+ "plugins": [],
591+ "extensions": [],
592+ "plugin_for": [],
593+ "extension_for": [],
594+ "module": "ScopeJS",
595+ "namespace": "",
596+ "file": "scope-metadata.js",
597+ "line": 1,
598+ "description": "Holds scope attributes such as name, description, icon etc"
599+ },
600+ "SearchMetadata": {
601+ "name": "SearchMetadata",
602+ "shortname": "SearchMetadata",
603+ "classitems": [],
604+ "plugins": [],
605+ "extensions": [],
606+ "plugin_for": [],
607+ "extension_for": [],
608+ "module": "ScopeJS",
609+ "namespace": "",
610+ "file": "search-metadata.js",
611+ "line": 1,
612+ "description": "Metadata passed with search requests.\nTwo forms of construction are allowed depending on the number\n and types of the parameters:\n - with locale and form factor\n or\n - with cardinality, locale, and form factor."
613+ },
614+ "SearchQuery": {
615+ "name": "SearchQuery",
616+ "shortname": "SearchQuery",
617+ "classitems": [],
618+ "plugins": [],
619+ "extensions": [],
620+ "plugin_for": [],
621+ "extension_for": [],
622+ "module": "ScopeJS",
623+ "namespace": "",
624+ "file": "search-query.js",
625+ "line": 1,
626+ "description": "Represents a particular query\n\n A scope must return an instance of this class from its implementation of Scope.search()."
627+ },
628+ "SearchReply": {
629+ "name": "SearchReply",
630+ "shortname": "SearchReply",
631+ "classitems": [],
632+ "plugins": [],
633+ "extensions": [],
634+ "plugin_for": [],
635+ "extension_for": [],
636+ "module": "ScopeJS",
637+ "namespace": "",
638+ "file": "search-reply.js",
639+ "line": 1,
640+ "description": "Allows the results of a preview to be sent to the preview requester."
641+ },
642+ "Scope": {
643+ "name": "Scope",
644+ "shortname": "Scope",
645+ "classitems": [],
646+ "plugins": [],
647+ "extensions": [],
648+ "plugin_for": [],
649+ "extension_for": [],
650+ "module": "ScopeJS",
651+ "namespace": "",
652+ "file": "index.js",
653+ "line": 25,
654+ "description": "Scope corresponds to the bridge between the ubuntu scope runtime\nand the actual scope.\n\nA Scope object is not directly constructible but it is automatically created\nwhen the scope module is imported and is accessible through the 'self' exported\nmember.\n\nAfter the scopes runtime has obtained initialization runtime configurations from\nthe scope, it calls start(), which allows the scope to intialize itself. This is\nfollowed by a call to run().\n\nWhen the scope should complete its activities, the runtime calls stop().",
655+ "example": [
656+ "\n var scopes = require('unity-js-scopes')\n scopes.self"
657+ ]
658+ }
659+ },
660+ "elements": {},
661+ "classitems": [
662+ {
663+ "file": "action-metadata.js",
664+ "line": 12,
665+ "description": "Check if this ActionMetadata has a hint",
666+ "itemtype": "method",
667+ "name": "contains_hint",
668+ "params": [
669+ {
670+ "name": "hint",
671+ "description": "",
672+ "type": "String"
673+ }
674+ ],
675+ "return": {
676+ "description": "Boolean"
677+ },
678+ "class": "ActionMetadata",
679+ "module": "ScopeJS"
680+ },
681+ {
682+ "file": "action-metadata.js",
683+ "line": 20,
684+ "description": "Set the value of an attribute",
685+ "itemtype": "method",
686+ "name": "set",
687+ "params": [
688+ {
689+ "name": "key",
690+ "description": "",
691+ "type": "String"
692+ },
693+ {
694+ "name": "value",
695+ "description": ", {Number} or {Object}",
696+ "type": "String"
697+ }
698+ ],
699+ "class": "ActionMetadata",
700+ "module": "ScopeJS"
701+ },
702+ {
703+ "file": "action-metadata.js",
704+ "line": 28,
705+ "description": "Get the value of an attribute",
706+ "itemtype": "method",
707+ "name": "get",
708+ "params": [
709+ {
710+ "name": "key",
711+ "description": "",
712+ "type": "String"
713+ }
714+ ],
715+ "return": {
716+ "description": ", {Number} or {Object}",
717+ "type": "String"
718+ },
719+ "class": "ActionMetadata",
720+ "module": "ScopeJS"
721+ },
722+ {
723+ "file": "activation-query.js",
724+ "line": 11,
725+ "description": "Return response to the activation request",
726+ "itemtype": "method",
727+ "name": "activate",
728+ "return": {
729+ "description": "ActivationResponse"
730+ },
731+ "class": "ActivationQuery",
732+ "module": "ScopeJS"
733+ },
734+ {
735+ "file": "activation-query.js",
736+ "line": 18,
737+ "description": "Get the result for this activation request handler",
738+ "itemtype": "method",
739+ "name": "result",
740+ "return": {
741+ "description": "Result"
742+ },
743+ "class": "ActivationQuery",
744+ "module": "ScopeJS"
745+ },
746+ {
747+ "file": "activation-query.js",
748+ "line": 25,
749+ "description": "Get the metadata for this activation request handler",
750+ "itemtype": "method",
751+ "name": "action_metadata",
752+ "return": {
753+ "description": "ActionMetadata"
754+ },
755+ "class": "ActivationQuery",
756+ "module": "ScopeJS"
757+ },
758+ {
759+ "file": "activation-query.js",
760+ "line": 32,
761+ "description": "Get the widget identifier for this activation request handler",
762+ "itemtype": "method",
763+ "name": "widget_id",
764+ "return": {
765+ "description": "String"
766+ },
767+ "class": "ActivationQuery",
768+ "module": "ScopeJS"
769+ },
770+ {
771+ "file": "activation-query.js",
772+ "line": 39,
773+ "description": "Get the action identifier for this activation request handler",
774+ "itemtype": "method",
775+ "name": "action_id",
776+ "return": {
777+ "description": "String"
778+ },
779+ "class": "ActivationQuery",
780+ "module": "ScopeJS"
781+ },
782+ {
783+ "file": "activation-query.js",
784+ "line": 46,
785+ "description": "Check whether this query is still valid",
786+ "itemtype": "method",
787+ "name": "valid",
788+ "return": {
789+ "description": "Boolean"
790+ },
791+ "class": "ActivationQuery",
792+ "module": "ScopeJS"
793+ },
794+ {
795+ "file": "activation-query.js",
796+ "line": 53,
797+ "description": "Returns a dictionary with the scope's current settings",
798+ "itemtype": "method",
799+ "name": "settings",
800+ "return": {
801+ "description": "Dictionary"
802+ },
803+ "class": "ActivationQuery",
804+ "module": "ScopeJS"
805+ },
806+ {
807+ "file": "categorised-result.js",
808+ "line": 13,
809+ "description": "Updates the category of this result.",
810+ "itemtype": "method",
811+ "name": "set_category",
812+ "params": [
813+ {
814+ "name": "category",
815+ "description": "The category for the result."
816+ }
817+ ],
818+ "class": "CategorisedResult",
819+ "module": "ScopeJS"
820+ },
821+ {
822+ "file": "categorised-result.js",
823+ "line": 20,
824+ "description": "Get the category instance this result belongs to.",
825+ "itemtype": "method",
826+ "name": "category",
827+ "return": {
828+ "description": "The category instance.",
829+ "type": "Category"
830+ },
831+ "class": "CategorisedResult",
832+ "module": "ScopeJS"
833+ },
834+ {
835+ "file": "categorised-result.js",
836+ "line": 27,
837+ "description": "This method is meant to be used by aggregator scopes which want to modify\nresults they receive, but want to keep a copy of the original result so\nthat they can be correctly handled by the original scopes\nwho created them when it comes to activation or previews.\nScopes middleware will automatically pass the correct inner stored result\nto the activation or preview request handler",
838+ "itemtype": "method",
839+ "name": "store",
840+ "params": [
841+ {
842+ "name": "The",
843+ "description": "original result to store within this result.",
844+ "type": "Result"
845+ },
846+ {
847+ "name": "intercept_activation",
848+ "description": "True if this scope should receive activation and preview requests.",
849+ "type": "Boolean"
850+ }
851+ ],
852+ "class": "CategorisedResult",
853+ "module": "ScopeJS"
854+ },
855+ {
856+ "file": "categorised-result.js",
857+ "line": 41,
858+ "description": "Check if this Result instance has a stored result.",
859+ "itemtype": "method",
860+ "name": "has_stored_result",
861+ "return": {
862+ "description": "True if there is a stored result",
863+ "type": "Boolean"
864+ },
865+ "class": "CategorisedResult",
866+ "module": "ScopeJS"
867+ },
868+ {
869+ "file": "categorised-result.js",
870+ "line": 48,
871+ "description": "Get a stored result.",
872+ "itemtype": "method",
873+ "name": "retrieve",
874+ "return": {
875+ "description": "stored result",
876+ "type": "Result"
877+ },
878+ "class": "CategorisedResult",
879+ "module": "ScopeJS"
880+ },
881+ {
882+ "file": "categorised-result.js",
883+ "line": 55,
884+ "description": "Set the \"uri\" attribute of this result.",
885+ "itemtype": "method",
886+ "name": "set_uri",
887+ "params": [
888+ {
889+ "name": "uri",
890+ "description": "",
891+ "type": "String"
892+ }
893+ ],
894+ "class": "CategorisedResult",
895+ "module": "ScopeJS"
896+ },
897+ {
898+ "file": "categorised-result.js",
899+ "line": 62,
900+ "description": "Set the \"title\" attribute of this result.",
901+ "itemtype": "method",
902+ "name": "set_title",
903+ "params": [
904+ {
905+ "name": "title",
906+ "description": "",
907+ "type": "String"
908+ }
909+ ],
910+ "class": "CategorisedResult",
911+ "module": "ScopeJS"
912+ },
913+ {
914+ "file": "categorised-result.js",
915+ "line": 69,
916+ "description": "Set the \"art\" attribute of this result.",
917+ "itemtype": "method",
918+ "name": "set_art",
919+ "params": [
920+ {
921+ "name": "art",
922+ "description": "",
923+ "type": "String"
924+ }
925+ ],
926+ "class": "CategorisedResult",
927+ "module": "ScopeJS"
928+ },
929+ {
930+ "file": "categorised-result.js",
931+ "line": 76,
932+ "description": "Set the \"dnd_uri\" attribute of this result.",
933+ "itemtype": "method",
934+ "name": "set_dnd_uri",
935+ "params": [
936+ {
937+ "name": "dnd_uri",
938+ "description": "",
939+ "type": "String"
940+ }
941+ ],
942+ "class": "CategorisedResult",
943+ "module": "ScopeJS"
944+ },
945+ {
946+ "file": "categorised-result.js",
947+ "line": 83,
948+ "description": "Indicates to the receiver that this scope should intercept\nactivation requests for this result.\nBy default, a scope receives preview requests for the results it\ncreates, but does not receive activation requests (they are handled\ndirectly by the shell). Intercepting activation implies intercepting\npreview requests as well; this is important for scopes that forward\nresults from other scopes and call set_intercept_activation() on these scopes.\nA scope that sets intercept activation flag for a result should re-implement\nScope.activate() and provide an implementation of ActivationQuery that\nhandles the actual activation. If not called, the result will be activated\ndirectly by the Unity shell whithout involving the scope, assuming an appropriate\nURI schema handler is present on the system.",
949+ "itemtype": "method",
950+ "name": "set_intercept_activation",
951+ "class": "CategorisedResult",
952+ "module": "ScopeJS"
953+ },
954+ {
955+ "file": "categorised-result.js",
956+ "line": 101,
957+ "description": "Check if this result should be activated directly by the shell\nbecause the scope doesn't handle activation of this result.",
958+ "itemtype": "method",
959+ "name": "direct_activation",
960+ "return": {
961+ "description": "True if this result needs to be activated directly.",
962+ "type": "Boolean"
963+ },
964+ "class": "CategorisedResult",
965+ "module": "ScopeJS"
966+ },
967+ {
968+ "file": "categorised-result.js",
969+ "line": 109,
970+ "description": "Get the \"uri\" property of this Result.\nThis method returns an empty string if this attribute is not of type String.",
971+ "itemtype": "method",
972+ "name": "uri",
973+ "return": {
974+ "description": "The value of \"uri\" or the empty string.",
975+ "type": "String"
976+ },
977+ "class": "CategorisedResult",
978+ "module": "ScopeJS"
979+ },
980+ {
981+ "file": "categorised-result.js",
982+ "line": 117,
983+ "description": "Get the \"title\" property of this Result.\nThis method returns an empty string if this attribute is not of type String.",
984+ "itemtype": "method",
985+ "name": "title",
986+ "return": {
987+ "description": "The value of \"title\" or the empty string.",
988+ "type": "String"
989+ },
990+ "class": "CategorisedResult",
991+ "module": "ScopeJS"
992+ },
993+ {
994+ "file": "categorised-result.js",
995+ "line": 125,
996+ "description": "Get the \"art\" property of this Result.\nThis method returns an empty string if this attribute is not of type String.",
997+ "itemtype": "method",
998+ "name": "art",
999+ "return": {
1000+ "description": "The value of \"art\" or the empty string.",
1001+ "type": "String"
1002+ },
1003+ "class": "CategorisedResult",
1004+ "module": "ScopeJS"
1005+ },
1006+ {
1007+ "file": "categorised-result.js",
1008+ "line": 133,
1009+ "description": "Get the \"dnd_uri\" property of this Result.\nThis method returns an empty string if this attribute is not of type String.",
1010+ "itemtype": "method",
1011+ "name": "dnd_uri",
1012+ "return": {
1013+ "description": "The value of \"dnd_uri\" or the empty string.",
1014+ "type": "String"
1015+ },
1016+ "class": "CategorisedResult",
1017+ "module": "ScopeJS"
1018+ },
1019+ {
1020+ "file": "categorised-result.js",
1021+ "line": 141,
1022+ "description": "Check if this Result has an attribute.",
1023+ "itemtype": "method",
1024+ "name": "contains",
1025+ "params": [
1026+ {
1027+ "name": "key",
1028+ "description": "The attribute name."
1029+ }
1030+ ],
1031+ "return": {
1032+ "description": "True if the attribute is set.",
1033+ "type": "Boolean"
1034+ },
1035+ "class": "CategorisedResult",
1036+ "module": "ScopeJS"
1037+ },
1038+ {
1039+ "file": "categorised-result.js",
1040+ "line": 149,
1041+ "description": "Check if this result is an online account login result.",
1042+ "itemtype": "method",
1043+ "name": "is_account_login_result",
1044+ "return": {
1045+ "description": "True if this result is an online account login result.",
1046+ "type": "Boolean"
1047+ },
1048+ "class": "CategorisedResult",
1049+ "module": "ScopeJS"
1050+ },
1051+ {
1052+ "file": "categorised-result.js",
1053+ "line": 156,
1054+ "description": "Gets the value of a custom metadata attribute.",
1055+ "itemtype": "method",
1056+ "name": "get",
1057+ "params": [
1058+ {
1059+ "name": "key",
1060+ "description": "The name of the attribute.",
1061+ "type": "String"
1062+ }
1063+ ],
1064+ "return": {
1065+ "description": "Attribute value or null"
1066+ },
1067+ "class": "CategorisedResult",
1068+ "module": "ScopeJS"
1069+ },
1070+ {
1071+ "file": "categorised-result.js",
1072+ "line": 164,
1073+ "description": "Sets the value of a custom metadata attribute.",
1074+ "itemtype": "method",
1075+ "name": "set",
1076+ "params": [
1077+ {
1078+ "name": "key",
1079+ "description": "The name of the attribute.",
1080+ "type": "String"
1081+ },
1082+ {
1083+ "name": "value",
1084+ "description": "The value of the attribute."
1085+ }
1086+ ],
1087+ "class": "CategorisedResult",
1088+ "module": "ScopeJS"
1089+ },
1090+ {
1091+ "file": "category-renderer.js",
1092+ "line": 13,
1093+ "description": "Returns complete renderer template definition in JSON format.",
1094+ "itemtype": "method",
1095+ "name": "data",
1096+ "return": {
1097+ "description": "String The renderer template (JSON)"
1098+ },
1099+ "class": "CategoryRenderer",
1100+ "module": "ScopeJS"
1101+ },
1102+ {
1103+ "file": "category.js",
1104+ "line": 14,
1105+ "description": "Get identifier of this Category",
1106+ "itemtype": "method",
1107+ "name": "id",
1108+ "return": {
1109+ "description": "String The category identifier."
1110+ },
1111+ "class": "Category",
1112+ "module": "ScopeJS"
1113+ },
1114+ {
1115+ "file": "category.js",
1116+ "line": 21,
1117+ "description": "Get title of this Category",
1118+ "itemtype": "method",
1119+ "name": "title",
1120+ "return": {
1121+ "description": "String The category title."
1122+ },
1123+ "class": "Category",
1124+ "module": "ScopeJS"
1125+ },
1126+ {
1127+ "file": "category.js",
1128+ "line": 28,
1129+ "description": "Get icon of this Category",
1130+ "itemtype": "method",
1131+ "name": "icon",
1132+ "return": {
1133+ "description": "String The category icon."
1134+ },
1135+ "class": "Category",
1136+ "module": "ScopeJS"
1137+ },
1138+ {
1139+ "file": "category.js",
1140+ "line": 35,
1141+ "description": "Query to perform when this category is expanded",
1142+ "itemtype": "method",
1143+ "name": "query",
1144+ "return": {
1145+ "description": "CannedQuery The expansion query or null."
1146+ },
1147+ "class": "Category",
1148+ "module": "ScopeJS"
1149+ },
1150+ {
1151+ "file": "column-layout.js",
1152+ "line": 13,
1153+ "description": "Adds a new column and assigns widgets to it.",
1154+ "itemtype": "method",
1155+ "name": "add_column",
1156+ "params": [
1157+ {
1158+ "name": "widget_ids",
1159+ "description": "ColumnLayout expects exactly the number of columns passed to the constructor to be created with the add_column method."
1160+ }
1161+ ],
1162+ "class": "ColumnLayout",
1163+ "module": "ScopeJS"
1164+ },
1165+ {
1166+ "file": "column-layout.js",
1167+ "line": 20,
1168+ "description": "Get the current number of columns in this layout.",
1169+ "itemtype": "method",
1170+ "name": "size",
1171+ "return": {
1172+ "description": "The number of columns added with add_column()"
1173+ },
1174+ "class": "ColumnLayout",
1175+ "module": "ScopeJS"
1176+ },
1177+ {
1178+ "file": "column-layout.js",
1179+ "line": 27,
1180+ "description": "Get the number of columns expected by this layout as specified in the constructor.",
1181+ "itemtype": "method",
1182+ "name": "number_of_columns",
1183+ "return": {
1184+ "description": "The number of columns expected by this layout."
1185+ },
1186+ "class": "ColumnLayout",
1187+ "module": "ScopeJS"
1188+ },
1189+ {
1190+ "file": "column-layout.js",
1191+ "line": 34,
1192+ "description": "Retrieve the list of widgets for given column.",
1193+ "itemtype": "method",
1194+ "name": "column",
1195+ "params": [
1196+ {
1197+ "name": "index",
1198+ "description": "The index of a column."
1199+ }
1200+ ],
1201+ "return": {
1202+ "description": "The widget identifiers for the given column index."
1203+ },
1204+ "class": "ColumnLayout",
1205+ "module": "ScopeJS"
1206+ },
1207+ {
1208+ "file": "department.js",
1209+ "line": 14,
1210+ "description": "Add sub-department to this department",
1211+ "itemtype": "method",
1212+ "name": "add_subdepartment",
1213+ "params": [
1214+ {
1215+ "name": "sub",
1216+ "description": "department",
1217+ "type": "Department"
1218+ }
1219+ ],
1220+ "class": "Department",
1221+ "module": "ScopeJS"
1222+ },
1223+ {
1224+ "file": "department.js",
1225+ "line": 21,
1226+ "description": "Get the alternate label of this department\nReturn the alternate label of this department. The alternate label expresses the plural \"all\" form of the normal label. For example, if the normal label is \"Books\", then the alternate label is \"All Books\". Note that alternate label and can be empty - in that case the normal label should be displayed instead",
1227+ "itemtype": "method",
1228+ "name": "alternate_label",
1229+ "return": {
1230+ "description": "alternate label",
1231+ "type": "String"
1232+ },
1233+ "class": "Department",
1234+ "module": "ScopeJS"
1235+ },
1236+ {
1237+ "file": "department.js",
1238+ "line": 29,
1239+ "description": "Set sub-departments of this department",
1240+ "params": [
1241+ {
1242+ "name": "departments",
1243+ "description": "",
1244+ "type": "Array of Department"
1245+ }
1246+ ],
1247+ "itemtype": "method",
1248+ "name": "set_subdepartments",
1249+ "class": "Department",
1250+ "module": "ScopeJS"
1251+ },
1252+ {
1253+ "file": "department.js",
1254+ "line": 36,
1255+ "description": "Sets has_subdepartments flag of this department",
1256+ "itemtype": "method",
1257+ "name": "set_has_subdepartments",
1258+ "params": [
1259+ {
1260+ "name": "subdepartments",
1261+ "description": "",
1262+ "type": "Boolean"
1263+ }
1264+ ],
1265+ "class": "Department",
1266+ "module": "ScopeJS"
1267+ },
1268+ {
1269+ "file": "department.js",
1270+ "line": 43,
1271+ "description": "Get the identifier of this department",
1272+ "itemtype": "method",
1273+ "name": "id",
1274+ "return": {
1275+ "description": "identifier of this department",
1276+ "type": "String"
1277+ },
1278+ "class": "Department",
1279+ "module": "ScopeJS"
1280+ },
1281+ {
1282+ "file": "department.js",
1283+ "line": 50,
1284+ "description": "Get the label of this department",
1285+ "itemtype": "method",
1286+ "name": "label",
1287+ "return": {
1288+ "description": "label of this department",
1289+ "type": "String"
1290+ },
1291+ "class": "Department",
1292+ "module": "ScopeJS"
1293+ },
1294+ {
1295+ "file": "department.js",
1296+ "line": 57,
1297+ "description": "Get the alternate label of this department",
1298+ "itemtype": "method",
1299+ "name": "alternate_label",
1300+ "return": {
1301+ "description": "alternate label of this department",
1302+ "type": "String"
1303+ },
1304+ "class": "Department",
1305+ "module": "ScopeJS"
1306+ },
1307+ {
1308+ "file": "department.js",
1309+ "line": 64,
1310+ "description": "Get the canned query associated with this department",
1311+ "itemtype": "method",
1312+ "name": "query",
1313+ "return": {
1314+ "description": "canned query associated with this department",
1315+ "type": "CannedQuery"
1316+ },
1317+ "class": "Department",
1318+ "module": "ScopeJS"
1319+ },
1320+ {
1321+ "file": "department.js",
1322+ "line": 71,
1323+ "description": "Get list of sub-departments of this department",
1324+ "itemtype": "method",
1325+ "name": "subdepartments",
1326+ "return": {
1327+ "description": "list of sub-departments of this department",
1328+ "type": "Array of Department"
1329+ },
1330+ "class": "Department",
1331+ "module": "ScopeJS"
1332+ },
1333+ {
1334+ "file": "department.js",
1335+ "line": 78,
1336+ "description": "Check if this department has subdepartments or has_subdepartments flag is set",
1337+ "itemtype": "method",
1338+ "name": "has_subdepartments",
1339+ "return": {
1340+ "description": "True if this department has subdepartments or has_subdepartments flag is set",
1341+ "type": "Boolean"
1342+ },
1343+ "class": "Department",
1344+ "module": "ScopeJS"
1345+ },
1346+ {
1347+ "file": "filter-option.js",
1348+ "line": 11,
1349+ "description": "Get the identifier of this filter option",
1350+ "itemtype": "method",
1351+ "name": "id",
1352+ "return": {
1353+ "description": "String The option identifier"
1354+ },
1355+ "class": "FilterOption",
1356+ "module": "ScopeJS"
1357+ },
1358+ {
1359+ "file": "filter-option.js",
1360+ "line": 18,
1361+ "description": "Get the label of this filter option",
1362+ "itemtype": "method",
1363+ "name": "label",
1364+ "return": {
1365+ "description": "String The option label"
1366+ },
1367+ "class": "FilterOption",
1368+ "module": "ScopeJS"
1369+ },
1370+ {
1371+ "file": "filter-state.js",
1372+ "line": 12,
1373+ "description": "Check if state for the given filter has been stored",
1374+ "itemtype": "method",
1375+ "name": "has_filter",
1376+ "params": [
1377+ {
1378+ "name": "id",
1379+ "description": "String filter id"
1380+ }
1381+ ],
1382+ "return": {
1383+ "description": "True if state for the given filter has been stored"
1384+ },
1385+ "class": "FilterOption",
1386+ "module": "ScopeJS"
1387+ },
1388+ {
1389+ "file": "filter-state.js",
1390+ "line": 20,
1391+ "description": "Removes the state for a specific filter",
1392+ "itemtype": "method",
1393+ "name": "remove",
1394+ "params": [
1395+ {
1396+ "name": "id",
1397+ "description": "String filter id"
1398+ }
1399+ ],
1400+ "class": "FilterOption",
1401+ "module": "ScopeJS"
1402+ },
1403+ {
1404+ "file": "online-account-client-service-status.js",
1405+ "line": 11,
1406+ "description": "Check if state for the given filter has been stored",
1407+ "itemtype": "property",
1408+ "name": "account_id",
1409+ "type": "String",
1410+ "class": "OnlineAccountClientServiceStatus",
1411+ "module": "ScopeJS"
1412+ },
1413+ {
1414+ "file": "online-account-client-service-status.js",
1415+ "line": 16,
1416+ "description": "True if this service is enabled",
1417+ "itemtype": "property",
1418+ "name": "service_enabled",
1419+ "type": "Boolean",
1420+ "class": "OnlineAccountClientServiceStatus",
1421+ "module": "ScopeJS"
1422+ },
1423+ {
1424+ "file": "online-account-client-service-status.js",
1425+ "line": 21,
1426+ "description": "True if this service is authenticated",
1427+ "itemtype": "property",
1428+ "name": "service_authenticated",
1429+ "type": "Boolean",
1430+ "class": "OnlineAccountClientServiceStatus",
1431+ "module": "ScopeJS"
1432+ },
1433+ {
1434+ "file": "online-account-client-service-status.js",
1435+ "line": 26,
1436+ "description": "\"ConsumerKey\" / \"ClientId\" OAuth (1 / 2) parameter.",
1437+ "itemtype": "property",
1438+ "name": "client_id",
1439+ "type": "String",
1440+ "class": "OnlineAccountClientServiceStatus",
1441+ "module": "ScopeJS"
1442+ },
1443+ {
1444+ "file": "online-account-client-service-status.js",
1445+ "line": 31,
1446+ "description": "\"ClientSecret\" / \"ConsumerSecret\" OAuth (1 / 2) parameter.",
1447+ "itemtype": "property",
1448+ "name": "client_secret",
1449+ "type": "String",
1450+ "class": "OnlineAccountClientServiceStatus",
1451+ "module": "ScopeJS"
1452+ },
1453+ {
1454+ "file": "online-account-client-service-status.js",
1455+ "line": 36,
1456+ "description": "\"AccessToken\" OAuth parameter.",
1457+ "itemtype": "property",
1458+ "name": "access_token",
1459+ "type": "String",
1460+ "class": "OnlineAccountClientServiceStatus",
1461+ "module": "ScopeJS"
1462+ },
1463+ {
1464+ "file": "online-account-client-service-status.js",
1465+ "line": 41,
1466+ "description": "\"TokenSecret\" OAuth parameter.",
1467+ "itemtype": "property",
1468+ "name": "token_secret",
1469+ "type": "String",
1470+ "class": "OnlineAccountClientServiceStatus",
1471+ "module": "ScopeJS"
1472+ },
1473+ {
1474+ "file": "online-account-client-service-status.js",
1475+ "line": 46,
1476+ "description": "Error message (empty if no error occurred).",
1477+ "itemtype": "property",
1478+ "name": "error",
1479+ "type": "String",
1480+ "class": "OnlineAccountClientServiceStatus",
1481+ "module": "ScopeJS"
1482+ },
1483+ {
1484+ "file": "online-account-client.js",
1485+ "line": 15,
1486+ "description": "Get statuses for all services matching the name, type and provider specified on construction",
1487+ "itemtype": "method",
1488+ "name": "get_service_statuses",
1489+ "return": {
1490+ "description": "list of service statuses",
1491+ "type": "Array of OnlineAccountClientServiceStatus"
1492+ },
1493+ "class": "OnlineAccountClient",
1494+ "module": "ScopeJS"
1495+ },
1496+ {
1497+ "file": "online-account-client.js",
1498+ "line": 22,
1499+ "description": "Refresh all service statuses\nWARNING: If a service update callback is set, this method will invoke that callback for each service monitored. Therefore, DO NOT call this method from within your callback function!",
1500+ "itemtype": "method",
1501+ "name": "refresh_service_statuses",
1502+ "class": "OnlineAccountClient",
1503+ "module": "ScopeJS"
1504+ },
1505+ {
1506+ "file": "online-account-client.js",
1507+ "line": 29,
1508+ "description": "Register a result item that requires the user to be logged in.",
1509+ "params": [
1510+ {
1511+ "name": "result",
1512+ "description": "The result item that needs account access",
1513+ "type": "Result"
1514+ },
1515+ {
1516+ "name": "query",
1517+ "description": "The scope's current query",
1518+ "type": "CannedQuery"
1519+ },
1520+ {
1521+ "name": "login_passed_action",
1522+ "description": "The action to take upon successful login",
1523+ "type": "PostLoginAction"
1524+ },
1525+ {
1526+ "name": "login_failed_action",
1527+ "description": "The action to take upon unsuccessful login",
1528+ "type": "PostLoginAction"
1529+ }
1530+ ],
1531+ "itemtype": "method",
1532+ "name": "register_account_login_item",
1533+ "class": "OnlineAccountClient",
1534+ "module": "ScopeJS"
1535+ },
1536+ {
1537+ "file": "online-account-client.js",
1538+ "line": 39,
1539+ "description": "Refresh all service statuses",
1540+ "itemtype": "method",
1541+ "name": "register_account_login_item",
1542+ "params": [
1543+ {
1544+ "name": "widget",
1545+ "description": "The widget item that needs account access",
1546+ "type": "PreviewWidget"
1547+ },
1548+ {
1549+ "name": "login_passed_action",
1550+ "description": "The action to take upon successful login",
1551+ "type": "PostLoginAction"
1552+ },
1553+ {
1554+ "name": "login_failed_action",
1555+ "description": "The action to take upon unsuccessful login",
1556+ "type": "PostLoginAction"
1557+ }
1558+ ],
1559+ "class": "OnlineAccountClient",
1560+ "module": "ScopeJS"
1561+ },
1562+ {
1563+ "file": "online-account-client.js",
1564+ "line": 48,
1565+ "description": "Set the callback function to be invoked when a service status changes",
1566+ "itemtype": "method",
1567+ "name": "set_service_update_callback",
1568+ "params": [
1569+ {
1570+ "name": "callback",
1571+ "description": "",
1572+ "type": "Function(OnlineAccountServiceStatus)"
1573+ }
1574+ ],
1575+ "class": "OnlineAccountClient",
1576+ "module": "ScopeJS"
1577+ },
1578+ {
1579+ "file": "option-selector-filter.js",
1580+ "line": 15,
1581+ "description": "Get the label of this filter",
1582+ "itemtype": "method",
1583+ "name": "label",
1584+ "return": {
1585+ "description": "label of this filter",
1586+ "type": "String"
1587+ },
1588+ "class": "OptionSelectorFilter",
1589+ "module": "ScopeJS"
1590+ },
1591+ {
1592+ "file": "option-selector-filter.js",
1593+ "line": 22,
1594+ "description": "Check if this filter supports multiple options to be selected",
1595+ "itemtype": "method",
1596+ "name": "multi_select",
1597+ "return": {
1598+ "description": "True if this filter multiple options to be selected",
1599+ "type": "Boolean"
1600+ },
1601+ "class": "OptionSelectorFilter",
1602+ "module": "ScopeJS"
1603+ },
1604+ {
1605+ "file": "option-selector-filter.js",
1606+ "line": 29,
1607+ "description": "Add a new option to this filter",
1608+ "itemtype": "method",
1609+ "name": "add_option",
1610+ "return": {
1611+ "description": "FilterOption The added filter option"
1612+ },
1613+ "class": "OptionSelectorFilter",
1614+ "module": "ScopeJS"
1615+ },
1616+ {
1617+ "file": "option-selector-filter.js",
1618+ "line": 36,
1619+ "description": "Get all options of this filter, in the order they were added",
1620+ "itemtype": "method",
1621+ "name": "options",
1622+ "return": {
1623+ "description": "",
1624+ "type": "Array of FilterOption"
1625+ },
1626+ "class": "OptionSelectorFilter",
1627+ "module": "ScopeJS"
1628+ },
1629+ {
1630+ "file": "option-selector-filter.js",
1631+ "line": 43,
1632+ "description": "Check if an option is active for this filter",
1633+ "itemtype": "method",
1634+ "name": "has_active_option",
1635+ "params": [
1636+ {
1637+ "name": "filter_state",
1638+ "description": "FilterState"
1639+ }
1640+ ],
1641+ "return": {
1642+ "description": "True if an option is active for this filter",
1643+ "type": "Boolean"
1644+ },
1645+ "class": "OptionSelectorFilter",
1646+ "module": "ScopeJS"
1647+ },
1648+ {
1649+ "file": "option-selector-filter.js",
1650+ "line": 51,
1651+ "description": "Get active options from an instance of FilterState for this filter",
1652+ "itemtype": "method",
1653+ "name": "active_options",
1654+ "params": [
1655+ {
1656+ "name": "filter_state",
1657+ "description": "FilterState"
1658+ }
1659+ ],
1660+ "return": {
1661+ "description": "LIst of active FilterOption",
1662+ "type": "Array of FilterOption"
1663+ },
1664+ "class": "OptionSelectorFilter",
1665+ "module": "ScopeJS"
1666+ },
1667+ {
1668+ "file": "option-selector-filter.js",
1669+ "line": 59,
1670+ "description": "Marks given FilterOption of this filter instance as active (or not active) in a FilterState object.\nRecords the given FilterOption as \"selected\" in the FilterState. This is meant to be used to modify a FilterState received with a search request before sending it back to the client (UI shell).",
1671+ "itemtype": "method",
1672+ "name": "update_state",
1673+ "params": [
1674+ {
1675+ "name": "filter_state",
1676+ "description": "",
1677+ "type": "FilterState"
1678+ },
1679+ {
1680+ "name": "option",
1681+ "description": "",
1682+ "type": "FilterOption"
1683+ },
1684+ {
1685+ "name": "active",
1686+ "description": "",
1687+ "type": "Boolean"
1688+ }
1689+ ],
1690+ "class": "OptionSelectorFilter",
1691+ "module": "ScopeJS"
1692+ },
1693+ {
1694+ "file": "option-selector-filter.js",
1695+ "line": 69,
1696+ "description": "Sets display hints for the Shell UI",
1697+ "itemtype": "method",
1698+ "name": "set_display_hints",
1699+ "params": [
1700+ {
1701+ "name": "hints",
1702+ "description": "0 is Default filter hint, 1 is Primary filter hint",
1703+ "type": "Int"
1704+ }
1705+ ],
1706+ "class": "OptionSelectorFilter",
1707+ "module": "ScopeJS"
1708+ },
1709+ {
1710+ "file": "option-selector-filter.js",
1711+ "line": 76,
1712+ "description": "Get the identifier of this filter",
1713+ "itemtype": "method",
1714+ "name": "id",
1715+ "return": {
1716+ "description": "identifier of this filter",
1717+ "type": "String"
1718+ },
1719+ "class": "OptionSelectorFilter",
1720+ "module": "ScopeJS"
1721+ },
1722+ {
1723+ "file": "option-selector-filter.js",
1724+ "line": 83,
1725+ "description": "Get the type name of this filter",
1726+ "itemtype": "method",
1727+ "name": "filter_type",
1728+ "return": {
1729+ "description": "type name of this filter",
1730+ "type": "String"
1731+ },
1732+ "class": "OptionSelectorFilter",
1733+ "module": "ScopeJS"
1734+ },
1735+ {
1736+ "file": "preview-query.js",
1737+ "line": 47,
1738+ "description": "Get result for this preview request",
1739+ "itemtype": "method",
1740+ "name": "result",
1741+ "return": {
1742+ "description": "Result"
1743+ },
1744+ "class": "PreviewQuery",
1745+ "module": "ScopeJS"
1746+ },
1747+ {
1748+ "file": "preview-query.js",
1749+ "line": 54,
1750+ "description": "Get metadata for this preview request",
1751+ "itemtype": "method",
1752+ "name": "action_metadata",
1753+ "return": {
1754+ "description": "ActionMetadata"
1755+ },
1756+ "class": "PreviewQuery",
1757+ "module": "ScopeJS"
1758+ },
1759+ {
1760+ "file": "preview-query.js",
1761+ "line": 61,
1762+ "description": "Check whether this query is still valid",
1763+ "itemtype": "method",
1764+ "name": "valid",
1765+ "return": {
1766+ "description": "Boolean"
1767+ },
1768+ "class": "PreviewQuery",
1769+ "module": "ScopeJS"
1770+ },
1771+ {
1772+ "file": "preview-query.js",
1773+ "line": 68,
1774+ "description": "Returns a dictionary with the scope's current settings",
1775+ "itemtype": "method",
1776+ "name": "settings",
1777+ "return": {
1778+ "description": "Dictionary"
1779+ },
1780+ "class": "PreviewQuery",
1781+ "module": "ScopeJS"
1782+ },
1783+ {
1784+ "file": "preview-reply.js",
1785+ "line": 12,
1786+ "description": "Registers a list of column layouts for the current preview",
1787+ "itemtype": "method",
1788+ "name": "register_layout",
1789+ "params": [
1790+ {
1791+ "name": "layout",
1792+ "description": "",
1793+ "type": "Array of Column layout"
1794+ }
1795+ ],
1796+ "class": "PreviewReply",
1797+ "module": "ScopeJS"
1798+ },
1799+ {
1800+ "file": "preview-reply.js",
1801+ "line": 19,
1802+ "description": "Sends widget definitions to the sender of the preview query",
1803+ "itemtype": "method",
1804+ "name": "push",
1805+ "params": [
1806+ {
1807+ "name": "widget_list",
1808+ "description": "",
1809+ "type": "Array of PreviewWidget"
1810+ }
1811+ ],
1812+ "class": "PreviewReply",
1813+ "module": "ScopeJS"
1814+ },
1815+ {
1816+ "file": "preview-reply.js",
1817+ "line": 26,
1818+ "description": "Informs the source of a query that the query results are complete",
1819+ "itemtype": "method",
1820+ "name": "finished",
1821+ "return": {
1822+ "description": "Boolean"
1823+ },
1824+ "class": "PreviewReply",
1825+ "module": "ScopeJS"
1826+ },
1827+ {
1828+ "file": "preview-reply.js",
1829+ "line": 33,
1830+ "description": "Informs the source of a query that the query was terminated due to an error",
1831+ "itemtype": "method",
1832+ "name": "error",
1833+ "return": {
1834+ "description": "error String error"
1835+ },
1836+ "class": "PreviewReply",
1837+ "module": "ScopeJS"
1838+ },
1839+ {
1840+ "file": "preview-widget.js",
1841+ "line": 12,
1842+ "description": "Adds an attribute definition and its value",
1843+ "itemtype": "method",
1844+ "name": "add_attribute_value",
1845+ "params": [
1846+ {
1847+ "name": "key",
1848+ "description": "Attribute definition",
1849+ "type": "String"
1850+ },
1851+ {
1852+ "name": "value",
1853+ "description": ", {Number}, {Object}. The value can be a string, number, object",
1854+ "type": "String"
1855+ }
1856+ ],
1857+ "class": "PreviewWidget",
1858+ "module": "ScopeJS"
1859+ },
1860+ {
1861+ "file": "preview-widget.js",
1862+ "line": 20,
1863+ "description": "Adds an attribute definition using a component mapping",
1864+ "itemtype": "method",
1865+ "name": "add_attribute_mapping",
1866+ "params": [
1867+ {
1868+ "name": "key",
1869+ "description": "Attribute definition",
1870+ "type": "String"
1871+ },
1872+ {
1873+ "name": "value",
1874+ "description": "Value",
1875+ "type": "String"
1876+ }
1877+ ],
1878+ "class": "PreviewWidget",
1879+ "module": "ScopeJS"
1880+ },
1881+ {
1882+ "file": "preview-widget.js",
1883+ "line": 28,
1884+ "description": "Adds a widget into expandable widget",
1885+ "itemtype": "method",
1886+ "name": "add_widget",
1887+ "params": [
1888+ {
1889+ "name": "widget",
1890+ "description": "The widget that needs to be added",
1891+ "type": "PreviewWidget"
1892+ }
1893+ ],
1894+ "class": "PreviewWidget",
1895+ "module": "ScopeJS"
1896+ },
1897+ {
1898+ "file": "preview-widget.js",
1899+ "line": 35,
1900+ "description": "Get the identifier of this widget",
1901+ "itemtype": "method",
1902+ "name": "id",
1903+ "return": {
1904+ "description": "Id",
1905+ "type": "String"
1906+ },
1907+ "class": "PreviewWidget",
1908+ "module": "ScopeJS"
1909+ },
1910+ {
1911+ "file": "preview-widget.js",
1912+ "line": 42,
1913+ "description": "Get type name of this widget",
1914+ "itemtype": "method",
1915+ "name": "widget_type",
1916+ "return": {
1917+ "description": "Widget type",
1918+ "type": "String"
1919+ },
1920+ "class": "PreviewWidget",
1921+ "module": "ScopeJS"
1922+ },
1923+ {
1924+ "file": "preview-widget.js",
1925+ "line": 49,
1926+ "description": "Get the components of this widget",
1927+ "itemtype": "method",
1928+ "name": "attribute_mappings",
1929+ "return": {
1930+ "description": "Dictionary of widget components"
1931+ },
1932+ "class": "PreviewWidget",
1933+ "module": "ScopeJS"
1934+ },
1935+ {
1936+ "file": "preview-widget.js",
1937+ "line": 56,
1938+ "description": "Get the attributes of this widget",
1939+ "itemtype": "method",
1940+ "name": "attribute_values",
1941+ "return": {
1942+ "description": "Object corresponding to attributes of this widget"
1943+ },
1944+ "class": "PreviewWidget",
1945+ "module": "ScopeJS"
1946+ },
1947+ {
1948+ "file": "preview-widget.js",
1949+ "line": 63,
1950+ "description": "Get widgets of 'expandable' widget",
1951+ "itemtype": "method",
1952+ "name": "widgets",
1953+ "return": {
1954+ "description": "List of PreviewWidget"
1955+ },
1956+ "class": "PreviewWidget",
1957+ "module": "ScopeJS"
1958+ },
1959+ {
1960+ "file": "preview-widget.js",
1961+ "line": 70,
1962+ "description": "Get a JSON representation of this widget",
1963+ "itemtype": "method",
1964+ "name": "data",
1965+ "return": {
1966+ "description": "String representation of widget"
1967+ },
1968+ "class": "PreviewWidget",
1969+ "module": "ScopeJS"
1970+ },
1971+ {
1972+ "file": "registry.js",
1973+ "line": 12,
1974+ "description": "Returns the metadata for the scope with the given ID",
1975+ "itemtype": "method",
1976+ "name": "get_metadata",
1977+ "params": [
1978+ {
1979+ "name": "id",
1980+ "description": "Attribute definition",
1981+ "type": "String"
1982+ }
1983+ ],
1984+ "return": {
1985+ "description": "",
1986+ "type": "ScopeMetadata"
1987+ },
1988+ "class": "Registry",
1989+ "module": "ScopeJS"
1990+ },
1991+ {
1992+ "file": "registry.js",
1993+ "line": 20,
1994+ "description": "Returns a map containing the metadata for all scopes",
1995+ "itemtype": "method",
1996+ "name": "list",
1997+ "return": {
1998+ "description": "",
1999+ "type": "Dictionary of String -> ScopeMetadata"
2000+ },
2001+ "class": "Registry",
2002+ "module": "ScopeJS"
2003+ },
2004+ {
2005+ "file": "registry.js",
2006+ "line": 27,
2007+ "description": "Returns a map containing only those scopes for which predicate returns true",
2008+ "itemtype": "method",
2009+ "name": "list_if",
2010+ "params": [
2011+ {
2012+ "name": "predicate",
2013+ "description": "a function that must return true for each metadata item to be included in the map.",
2014+ "type": "Function(ScopeMetadata)"
2015+ }
2016+ ],
2017+ "return": {
2018+ "description": "",
2019+ "type": "Dictionary of String -> ScopeMetadata"
2020+ },
2021+ "class": "Registry",
2022+ "module": "ScopeJS"
2023+ },
2024+ {
2025+ "file": "registry.js",
2026+ "line": 35,
2027+ "description": "Returns whether a scope is currently running or not",
2028+ "itemtype": "method",
2029+ "name": "is_scope_running",
2030+ "params": [
2031+ {
2032+ "name": "scope_id",
2033+ "description": "The ID of the scope from which we wish to retrieve state",
2034+ "type": "String"
2035+ }
2036+ ],
2037+ "return": {
2038+ "description": "True if the scope is running, and False if it is not running",
2039+ "type": "Boolean"
2040+ },
2041+ "class": "Registry",
2042+ "module": "ScopeJS"
2043+ },
2044+ {
2045+ "file": "registry.js",
2046+ "line": 43,
2047+ "description": "Assigns a callback method to be executed when a scope's running state (started / stopped) changes",
2048+ "itemtype": "method",
2049+ "name": "set_scope_state_callback",
2050+ "params": [
2051+ {
2052+ "name": "scope_id",
2053+ "description": "The ID of the scope from which we wish to retrieve state changes",
2054+ "type": "String"
2055+ },
2056+ {
2057+ "name": "callback",
2058+ "description": "The function that is invoked when a scope changes running state",
2059+ "type": "Function(is_running: Boolean)"
2060+ }
2061+ ],
2062+ "class": "Registry",
2063+ "module": "ScopeJS"
2064+ },
2065+ {
2066+ "file": "registry.js",
2067+ "line": 51,
2068+ "description": "Assigns a callback method to be executed when the registry's scope list changes\n\nNote: Upon receiving this callback, you should retrieve the updated scopes list via the list() method if you wish to retain synchronisation between client and server",
2069+ "itemtype": "method",
2070+ "name": "set_list_update_callback",
2071+ "params": [
2072+ {
2073+ "name": "callback",
2074+ "description": "The function that is invoked when an update occurs",
2075+ "type": "Function()"
2076+ }
2077+ ],
2078+ "class": "Registry",
2079+ "module": "ScopeJS"
2080+ },
2081+ {
2082+ "file": "result.js",
2083+ "line": 13,
2084+ "description": "Check if this Result instance has a stored result",
2085+ "itemtype": "method",
2086+ "name": "has_stored_result",
2087+ "return": {
2088+ "description": "",
2089+ "type": "Boolean"
2090+ },
2091+ "class": "Result",
2092+ "module": "ScopeJS"
2093+ },
2094+ {
2095+ "file": "result.js",
2096+ "line": 20,
2097+ "description": "Get a stored result",
2098+ "itemtype": "method",
2099+ "name": "retrieve",
2100+ "return": {
2101+ "description": "",
2102+ "type": "Result"
2103+ },
2104+ "class": "Result",
2105+ "module": "ScopeJS"
2106+ },
2107+ {
2108+ "file": "result.js",
2109+ "line": 27,
2110+ "description": "Set the \"uri\" attribute of this result.",
2111+ "itemtype": "method",
2112+ "name": "set_uri",
2113+ "params": [
2114+ {
2115+ "name": "uri",
2116+ "description": "",
2117+ "type": "String"
2118+ }
2119+ ],
2120+ "class": "Result",
2121+ "module": "ScopeJS"
2122+ },
2123+ {
2124+ "file": "result.js",
2125+ "line": 34,
2126+ "description": "Set the \"title\" attribute of this result.",
2127+ "itemtype": "method",
2128+ "name": "set_title",
2129+ "params": [
2130+ {
2131+ "name": "title",
2132+ "description": "",
2133+ "type": "String"
2134+ }
2135+ ],
2136+ "class": "Result",
2137+ "module": "ScopeJS"
2138+ },
2139+ {
2140+ "file": "result.js",
2141+ "line": 41,
2142+ "description": "Set the \"art\" attribute of this result.",
2143+ "itemtype": "method",
2144+ "name": "set_art",
2145+ "params": [
2146+ {
2147+ "name": "art",
2148+ "description": "",
2149+ "type": "String"
2150+ }
2151+ ],
2152+ "class": "Result",
2153+ "module": "ScopeJS"
2154+ },
2155+ {
2156+ "file": "result.js",
2157+ "line": 48,
2158+ "description": "Set the \"dnd_uri\" attribute of this result.",
2159+ "itemtype": "method",
2160+ "name": "set_dnd_uri",
2161+ "params": [
2162+ {
2163+ "name": "dnd_uri",
2164+ "description": "",
2165+ "type": "String"
2166+ }
2167+ ],
2168+ "class": "Result",
2169+ "module": "ScopeJS"
2170+ },
2171+ {
2172+ "file": "result.js",
2173+ "line": 55,
2174+ "description": "Indicates to the receiver that this scope should intercept activation requests for this result",
2175+ "itemtype": "method",
2176+ "name": "set_intercept_activation",
2177+ "class": "Result",
2178+ "module": "ScopeJS"
2179+ },
2180+ {
2181+ "file": "result.js",
2182+ "line": 61,
2183+ "description": "Check if this result should be activated directly by the shell because the scope doesn't handle activation of this result",
2184+ "itemtype": "method",
2185+ "name": "direct_activation",
2186+ "return": {
2187+ "description": "",
2188+ "type": "Boolean"
2189+ },
2190+ "class": "Result",
2191+ "module": "ScopeJS"
2192+ },
2193+ {
2194+ "file": "result.js",
2195+ "line": 68,
2196+ "description": "Get the \"uri\" property of this Result",
2197+ "itemtype": "method",
2198+ "name": "uri",
2199+ "return": {
2200+ "description": "",
2201+ "type": "String"
2202+ },
2203+ "class": "Result",
2204+ "module": "ScopeJS"
2205+ },
2206+ {
2207+ "file": "result.js",
2208+ "line": 75,
2209+ "description": "Get the \"title\" property of this Result",
2210+ "itemtype": "method",
2211+ "name": "title",
2212+ "return": {
2213+ "description": "",
2214+ "type": "String"
2215+ },
2216+ "class": "Result",
2217+ "module": "ScopeJS"
2218+ },
2219+ {
2220+ "file": "result.js",
2221+ "line": 82,
2222+ "description": "Get the \"art\" property of this Result",
2223+ "itemtype": "method",
2224+ "name": "art",
2225+ "return": {
2226+ "description": "",
2227+ "type": "String"
2228+ },
2229+ "class": "Result",
2230+ "module": "ScopeJS"
2231+ },
2232+ {
2233+ "file": "result.js",
2234+ "line": 89,
2235+ "description": "Get the \"dnd_uri\" property of this Result",
2236+ "itemtype": "method",
2237+ "name": "dnd_uri",
2238+ "return": {
2239+ "description": "",
2240+ "type": "String"
2241+ },
2242+ "class": "Result",
2243+ "module": "ScopeJS"
2244+ },
2245+ {
2246+ "file": "result.js",
2247+ "line": 96,
2248+ "description": "Check if this Result has an attribute",
2249+ "itemtype": "method",
2250+ "name": "contains",
2251+ "return": {
2252+ "description": "",
2253+ "type": "Boolean"
2254+ },
2255+ "class": "Result",
2256+ "module": "ScopeJS"
2257+ },
2258+ {
2259+ "file": "result.js",
2260+ "line": 103,
2261+ "description": "Get the value of an attribute",
2262+ "itemtype": "method",
2263+ "name": "value",
2264+ "params": [
2265+ {
2266+ "name": "value",
2267+ "description": "",
2268+ "type": "String"
2269+ }
2270+ ],
2271+ "return": {
2272+ "description": "",
2273+ "type": "Dictonary"
2274+ },
2275+ "class": "Result",
2276+ "module": "ScopeJS"
2277+ },
2278+ {
2279+ "file": "result.js",
2280+ "line": 111,
2281+ "description": "Set the value of an attribute",
2282+ "itemtype": "method",
2283+ "name": "set",
2284+ "params": [
2285+ {
2286+ "name": "key",
2287+ "description": "",
2288+ "type": "String"
2289+ },
2290+ {
2291+ "name": "value",
2292+ "description": "",
2293+ "type": "String"
2294+ }
2295+ ],
2296+ "class": "Result",
2297+ "module": "ScopeJS"
2298+ },
2299+ {
2300+ "file": "result.js",
2301+ "line": 119,
2302+ "description": "Get the value of an attribute",
2303+ "itemtype": "method",
2304+ "name": "get",
2305+ "params": [
2306+ {
2307+ "name": "key",
2308+ "description": "",
2309+ "type": "String"
2310+ }
2311+ ],
2312+ "return": {
2313+ "description": ", {Number} or {Object}",
2314+ "type": "String"
2315+ },
2316+ "class": "Result",
2317+ "module": "ScopeJS"
2318+ },
2319+ {
2320+ "file": "scope-metadata.js",
2321+ "line": 12,
2322+ "description": "Get the scope identifier",
2323+ "itemtype": "method",
2324+ "name": "scope_id",
2325+ "return": {
2326+ "description": "",
2327+ "type": "String"
2328+ },
2329+ "class": "ScopeMetadata",
2330+ "module": "ScopeJS"
2331+ },
2332+ {
2333+ "file": "scope-metadata.js",
2334+ "line": 19,
2335+ "description": "Get the scope display name",
2336+ "itemtype": "method",
2337+ "name": "display_name",
2338+ "return": {
2339+ "description": "",
2340+ "type": "String"
2341+ },
2342+ "class": "ScopeMetadata",
2343+ "module": "ScopeJS"
2344+ },
2345+ {
2346+ "file": "scope-metadata.js",
2347+ "line": 26,
2348+ "description": "Get the scope description",
2349+ "itemtype": "method",
2350+ "name": "description",
2351+ "return": {
2352+ "description": "",
2353+ "type": "String"
2354+ },
2355+ "class": "ScopeMetadata",
2356+ "module": "ScopeJS"
2357+ },
2358+ {
2359+ "file": "scope-metadata.js",
2360+ "line": 33,
2361+ "description": "Get the scope author",
2362+ "itemtype": "method",
2363+ "name": "author",
2364+ "return": {
2365+ "description": "",
2366+ "type": "String"
2367+ },
2368+ "class": "ScopeMetadata",
2369+ "module": "ScopeJS"
2370+ },
2371+ {
2372+ "file": "scope-metadata.js",
2373+ "line": 40,
2374+ "description": "Get the scope art",
2375+ "itemtype": "method",
2376+ "name": "art",
2377+ "return": {
2378+ "description": "",
2379+ "type": "String"
2380+ },
2381+ "class": "ScopeMetadata",
2382+ "module": "ScopeJS"
2383+ },
2384+ {
2385+ "file": "scope-metadata.js",
2386+ "line": 47,
2387+ "description": "Get the scope icon",
2388+ "itemtype": "method",
2389+ "name": "icon",
2390+ "return": {
2391+ "description": "",
2392+ "type": "String"
2393+ },
2394+ "class": "ScopeMetadata",
2395+ "module": "ScopeJS"
2396+ },
2397+ {
2398+ "file": "scope-metadata.js",
2399+ "line": 54,
2400+ "description": "Get the scope search_hint",
2401+ "itemtype": "method",
2402+ "name": "search_hint",
2403+ "return": {
2404+ "description": "",
2405+ "type": "String"
2406+ },
2407+ "class": "ScopeMetadata",
2408+ "module": "ScopeJS"
2409+ },
2410+ {
2411+ "file": "scope-metadata.js",
2412+ "line": 61,
2413+ "description": "Get the scope hot key",
2414+ "itemtype": "method",
2415+ "name": "hot_key",
2416+ "return": {
2417+ "description": "",
2418+ "type": "String"
2419+ },
2420+ "class": "ScopeMetadata",
2421+ "module": "ScopeJS"
2422+ },
2423+ {
2424+ "file": "scope-metadata.js",
2425+ "line": 68,
2426+ "description": "Checks if the scope is invisible",
2427+ "itemtype": "method",
2428+ "name": "invisible",
2429+ "return": {
2430+ "description": "",
2431+ "type": "Boolean"
2432+ },
2433+ "class": "ScopeMetadata",
2434+ "module": "ScopeJS"
2435+ },
2436+ {
2437+ "file": "scope-metadata.js",
2438+ "line": 75,
2439+ "description": "Gets the scope directory",
2440+ "itemtype": "method",
2441+ "name": "scope_directory",
2442+ "return": {
2443+ "description": "",
2444+ "type": "String"
2445+ },
2446+ "class": "ScopeMetadata",
2447+ "module": "ScopeJS"
2448+ },
2449+ {
2450+ "file": "scope-metadata.js",
2451+ "line": 82,
2452+ "description": "Checks if the scope needs location data",
2453+ "itemtype": "method",
2454+ "name": "location_data_needed",
2455+ "return": {
2456+ "description": "",
2457+ "type": "Boolean"
2458+ },
2459+ "class": "ScopeMetadata",
2460+ "module": "ScopeJS"
2461+ },
2462+ {
2463+ "file": "search-metadata.js",
2464+ "line": 22,
2465+ "description": "Set cardinality.",
2466+ "itemtype": "method",
2467+ "name": "set_cardinality",
2468+ "params": [
2469+ {
2470+ "name": "cardinality",
2471+ "description": "",
2472+ "type": "Int"
2473+ }
2474+ ],
2475+ "class": "SearchMetadata",
2476+ "module": "ScopeJS"
2477+ },
2478+ {
2479+ "file": "search-metadata.js",
2480+ "line": 29,
2481+ "description": "Get cardinality.",
2482+ "itemtype": "method",
2483+ "name": "cardinality",
2484+ "return": {
2485+ "description": "",
2486+ "type": "Int"
2487+ },
2488+ "class": "SearchMetadata",
2489+ "module": "ScopeJS"
2490+ },
2491+ {
2492+ "file": "search-metadata.js",
2493+ "line": 36,
2494+ "description": "Set location.",
2495+ "itemtype": "method",
2496+ "name": "set_location",
2497+ "params": [
2498+ {
2499+ "name": "location",
2500+ "description": "data",
2501+ "type": "Location"
2502+ }
2503+ ],
2504+ "class": "SearchMetadata",
2505+ "module": "ScopeJS"
2506+ },
2507+ {
2508+ "file": "search-metadata.js",
2509+ "line": 43,
2510+ "description": "Get location.",
2511+ "itemtype": "method",
2512+ "name": "location",
2513+ "return": {
2514+ "description": "data representing the current location, including attributes such as city and country.",
2515+ "type": "Location"
2516+ },
2517+ "class": "SearchMetadata",
2518+ "module": "ScopeJS"
2519+ },
2520+ {
2521+ "file": "search-metadata.js",
2522+ "line": 50,
2523+ "description": "Does the SearchMetadata have a location.",
2524+ "itemtype": "method",
2525+ "name": "has_location",
2526+ "return": {
2527+ "description": "True if there is a location property.",
2528+ "type": "Boolean"
2529+ },
2530+ "class": "SearchMetadata",
2531+ "module": "ScopeJS"
2532+ },
2533+ {
2534+ "file": "search-metadata.js",
2535+ "line": 57,
2536+ "description": "Remove location data entirely.\nThis method does nothing if no location data is present.",
2537+ "itemtype": "method",
2538+ "name": "remove_location",
2539+ "class": "SearchMetadata",
2540+ "module": "ScopeJS"
2541+ },
2542+ {
2543+ "file": "search-metadata.js",
2544+ "line": 64,
2545+ "description": "Set the list of scope keywords used to initiate this search request.",
2546+ "itemtype": "method",
2547+ "name": "set_aggregated_keywords",
2548+ "params": [
2549+ {
2550+ "name": "aggregated_keywords",
2551+ "description": "The list of scope keywords used to initiate this search request.",
2552+ "type": "Array of String"
2553+ }
2554+ ],
2555+ "class": "SearchMetadata",
2556+ "module": "ScopeJS"
2557+ },
2558+ {
2559+ "file": "search-metadata.js",
2560+ "line": 71,
2561+ "description": "Get the list of scope keywords used to initiate this search request.",
2562+ "itemtype": "method",
2563+ "name": "aggregated_keywords",
2564+ "return": {
2565+ "description": "The list of scope keywords used to initiate this search request.",
2566+ "type": "Array of String"
2567+ },
2568+ "class": "SearchMetadata",
2569+ "module": "ScopeJS"
2570+ },
2571+ {
2572+ "file": "search-metadata.js",
2573+ "line": 78,
2574+ "description": "Check if this search request originated from an aggregator scope.",
2575+ "itemtype": "method",
2576+ "name": "is_aggregated",
2577+ "return": {
2578+ "description": "True if this search request originated from an aggregator scope.",
2579+ "type": "Boolean"
2580+ },
2581+ "class": "SearchMetadata",
2582+ "module": "ScopeJS"
2583+ },
2584+ {
2585+ "file": "search-metadata.js",
2586+ "line": 85,
2587+ "description": "Sets a hint.",
2588+ "itemtype": "method",
2589+ "name": "set_hint",
2590+ "params": [
2591+ {
2592+ "name": "key",
2593+ "description": "The name of the hint.",
2594+ "type": "String"
2595+ },
2596+ {
2597+ "name": "value",
2598+ "description": "Hint value"
2599+ }
2600+ ],
2601+ "class": "SearchMetadata",
2602+ "module": "ScopeJS"
2603+ },
2604+ {
2605+ "file": "search-metadata.js",
2606+ "line": 93,
2607+ "description": "Get all hints.",
2608+ "itemtype": "method",
2609+ "name": "hints",
2610+ "return": {
2611+ "description": "",
2612+ "type": "Dictionary"
2613+ },
2614+ "class": "SearchMetadata",
2615+ "module": "ScopeJS"
2616+ },
2617+ {
2618+ "file": "search-metadata.js",
2619+ "line": 100,
2620+ "description": "Check if this SearchMetadata has a hint.",
2621+ "itemtype": "method",
2622+ "name": "contains_hint",
2623+ "params": [
2624+ {
2625+ "name": "key",
2626+ "description": "The hint name.",
2627+ "type": "String"
2628+ }
2629+ ],
2630+ "return": {
2631+ "description": "True if the hint is set.",
2632+ "type": "Boolean"
2633+ },
2634+ "class": "SearchMetadata",
2635+ "module": "ScopeJS"
2636+ },
2637+ {
2638+ "file": "search-metadata.js",
2639+ "line": 108,
2640+ "description": "Set the value of an attribute",
2641+ "itemtype": "method",
2642+ "name": "set",
2643+ "params": [
2644+ {
2645+ "name": "key",
2646+ "description": "",
2647+ "type": "String"
2648+ },
2649+ {
2650+ "name": "value",
2651+ "description": ", {Number} or {Object}",
2652+ "type": "String"
2653+ }
2654+ ],
2655+ "class": "SearchMetadata",
2656+ "module": "ScopeJS"
2657+ },
2658+ {
2659+ "file": "search-metadata.js",
2660+ "line": 116,
2661+ "description": "Get the value of an attribute",
2662+ "itemtype": "method",
2663+ "name": "get",
2664+ "params": [
2665+ {
2666+ "name": "key",
2667+ "description": "",
2668+ "type": "String"
2669+ }
2670+ ],
2671+ "return": {
2672+ "description": ", {Number} or {Object}",
2673+ "type": "String"
2674+ },
2675+ "class": "SearchMetadata",
2676+ "module": "ScopeJS"
2677+ },
2678+ {
2679+ "file": "search-metadata.js",
2680+ "line": 124,
2681+ "description": "Get the form factor string.",
2682+ "itemtype": "method",
2683+ "name": "form_factor",
2684+ "return": {
2685+ "description": "The form factor string"
2686+ },
2687+ "class": "SearchMetadata",
2688+ "module": "ScopeJS"
2689+ },
2690+ {
2691+ "file": "search-metadata.js",
2692+ "line": 131,
2693+ "description": "Get the locale string.",
2694+ "itemtype": "method",
2695+ "name": "locale",
2696+ "return": {
2697+ "description": "The locale string"
2698+ },
2699+ "class": "SearchMetadata",
2700+ "module": "ScopeJS"
2701+ },
2702+ {
2703+ "file": "search-metadata.js",
2704+ "line": 138,
2705+ "description": "Get internet connectivity status.",
2706+ "itemtype": "method",
2707+ "name": "internet_connectivity",
2708+ "return": {
2709+ "description": "The internet connectivity status.",
2710+ "type": "ConnectivityStatus"
2711+ },
2712+ "class": "SearchMetadata",
2713+ "module": "ScopeJS"
2714+ },
2715+ {
2716+ "file": "search-metadata.js",
2717+ "line": 145,
2718+ "description": "Set internet connectivity status.",
2719+ "itemtype": "method",
2720+ "name": "set_internet_connectivity",
2721+ "params": [
2722+ {
2723+ "name": "The",
2724+ "description": "internet connectivity status.",
2725+ "type": "ConnectivityStatus"
2726+ }
2727+ ],
2728+ "class": "SearchMetadata",
2729+ "module": "ScopeJS"
2730+ },
2731+ {
2732+ "file": "search-query.js",
2733+ "line": 50,
2734+ "description": "Get a canned query for this search request",
2735+ "itemtype": "method",
2736+ "name": "query",
2737+ "return": {
2738+ "description": "CannedQuery"
2739+ },
2740+ "class": "SearchQuery",
2741+ "module": "ScopeJS"
2742+ },
2743+ {
2744+ "file": "search-query.js",
2745+ "line": 57,
2746+ "description": "Get metadata for this search request",
2747+ "itemtype": "method",
2748+ "name": "search_metadata",
2749+ "return": {
2750+ "description": "SearchMetadata"
2751+ },
2752+ "class": "SearchQuery",
2753+ "module": "ScopeJS"
2754+ },
2755+ {
2756+ "file": "search-query.js",
2757+ "line": 64,
2758+ "description": "Check whether this query is still valid",
2759+ "itemtype": "method",
2760+ "name": "valid",
2761+ "return": {
2762+ "description": "Boolean False if the query is finished or was cancelled ealier."
2763+ },
2764+ "class": "SearchQuery",
2765+ "module": "ScopeJS"
2766+ },
2767+ {
2768+ "file": "search-query.js",
2769+ "line": 71,
2770+ "description": "Returns a dictionary with the scope's current settings",
2771+ "itemtype": "method",
2772+ "name": "settings",
2773+ "return": {
2774+ "description": "Dictionary"
2775+ },
2776+ "class": "SearchQuery",
2777+ "module": "ScopeJS"
2778+ },
2779+ {
2780+ "file": "search-reply.js",
2781+ "line": 11,
2782+ "description": "Register new category and send it to the source of the query",
2783+ "itemtype": "method",
2784+ "name": "register_category",
2785+ "params": [
2786+ {
2787+ "name": "id",
2788+ "description": "String id"
2789+ },
2790+ {
2791+ "name": "title",
2792+ "description": "String title"
2793+ },
2794+ {
2795+ "name": "icon",
2796+ "description": "String icon"
2797+ },
2798+ {
2799+ "name": "category_renderer",
2800+ "description": "CategoryRenderer"
2801+ }
2802+ ],
2803+ "class": "SearchReply",
2804+ "module": "ScopeJS"
2805+ },
2806+ {
2807+ "file": "search-reply.js",
2808+ "line": 21,
2809+ "description": "Returns a previously registered category",
2810+ "itemtype": "method",
2811+ "name": "id",
2812+ "params": [
2813+ {
2814+ "name": "id",
2815+ "description": ""
2816+ }
2817+ ],
2818+ "class": "SearchReply",
2819+ "module": "ScopeJS"
2820+ },
2821+ {
2822+ "file": "search-reply.js",
2823+ "line": 28,
2824+ "description": "Sends a single result to the source of a query",
2825+ "itemtype": "method",
2826+ "name": "push",
2827+ "params": [
2828+ {
2829+ "name": "result",
2830+ "description": "CategorisedResult"
2831+ }
2832+ ],
2833+ "class": "SearchReply",
2834+ "module": "ScopeJS"
2835+ },
2836+ {
2837+ "file": "search-reply.js",
2838+ "line": 35,
2839+ "description": "Informs the source of a query that the query was terminated due to an error",
2840+ "itemtype": "method",
2841+ "name": "error",
2842+ "return": {
2843+ "description": "error String error"
2844+ },
2845+ "class": "SearchReply",
2846+ "module": "ScopeJS"
2847+ },
2848+ {
2849+ "file": "search-reply.js",
2850+ "line": 42,
2851+ "description": "Informs the source of a query that the query results are complete",
2852+ "itemtype": "method",
2853+ "name": "finished",
2854+ "class": "SearchReply",
2855+ "module": "ScopeJS"
2856+ },
2857+ {
2858+ "file": "index.js",
2859+ "line": 51,
2860+ "description": "This member function is the entry point to setting up a scope's behavior\nand configuring it to the runtime scope.",
2861+ "itemtype": "method",
2862+ "name": "initialize",
2863+ "params": [
2864+ {
2865+ "name": "options",
2866+ "description": "A dictionary of options for the scope runtime.\n The option keys are:\n - scope_id: the scope id",
2867+ "type": "Object"
2868+ },
2869+ {
2870+ "name": "runtime_config",
2871+ "description": "A dictionary of runtime configuration settings for the scope runtime.\n The configuration keys are:\n - run {Function()}: Callback called by the scopes run time after it has called start() to hand a thread of control to the scope\n - starting {Function(String: scope_id)}: Callback called by the scopes run time after the create function completes\n - stop {Function()}: Callback called by the scopes run time when the scope should shut down\n - search {Function(CannedQuery: canned_query, SearchMetaData: metadata)}: Callback called by the scopes run time when a scope needs to instantiate a query\n - perform_action {Function(Result: result, ActionMetaData: metadata, String: widget_id, String: ation_id)}: Callback invoked when a scope is requested to handle a preview action\n - preview {Function(Result: result, ActionMetaData: metadata)}: Callback invoked when a scope is requested to create a preview for a particular result",
2872+ "type": "Object"
2873+ }
2874+ ],
2875+ "example": [
2876+ "\n var scopes = require('unity-js-scopes')\n scopes.self.initialize(\n {}, {\n run: function() {}\n start: function(scope_id) {\n console.log('Starting scope id: '\n + scope_id\n + ', '\n + scopes.self.scope_config)\n },\n search: function(canned_query, metadata) {}\n }\n );"
2877+ ],
2878+ "class": "Scope",
2879+ "module": "ScopeJS"
2880+ },
2881+ {
2882+ "file": "index.js",
2883+ "line": 127,
2884+ "description": "Returns the directory that stores the scope's configuration files and shared library",
2885+ "itemtype": "property",
2886+ "name": "scope_directory",
2887+ "class": "Scope",
2888+ "module": "ScopeJS"
2889+ },
2890+ {
2891+ "file": "index.js",
2892+ "line": 135,
2893+ "description": "Returns a directory that is (exclusively) writable for the scope",
2894+ "itemtype": "property",
2895+ "name": "cache_directory",
2896+ "class": "Scope",
2897+ "module": "ScopeJS"
2898+ },
2899+ {
2900+ "file": "index.js",
2901+ "line": 143,
2902+ "description": "Returns a tmp directory that is (exclusively) writable for the scope",
2903+ "itemtype": "property",
2904+ "name": "tmp_directory",
2905+ "class": "Scope",
2906+ "module": "ScopeJS"
2907+ },
2908+ {
2909+ "file": "index.js",
2910+ "line": 151,
2911+ "description": "Returns the scope registry",
2912+ "itemtype": "property",
2913+ "name": "registry",
2914+ "class": "Scope",
2915+ "module": "ScopeJS"
2916+ },
2917+ {
2918+ "file": "index.js",
2919+ "line": 159,
2920+ "description": "Returns a dictionary with the scope's current settings",
2921+ "itemtype": "property",
2922+ "name": "settings",
2923+ "class": "Scope",
2924+ "module": "ScopeJS"
2925+ }
2926+ ],
2927+ "warnings": []
2928+}
2929\ No newline at end of file
2930
2931=== modified file 'doc/generate-doc.py'
2932--- doc/generate-doc.py 2015-11-20 17:30:16 +0000
2933+++ doc/generate-doc.py 2016-01-08 14:42:13 +0000
2934@@ -21,6 +21,7 @@
2935 import subprocess
2936 import sys
2937 import shutil
2938+import re
2939
2940 def usage():
2941 print("generate-doc.py SOURCE_DIRECTORY TARGET_DOC_DIRECTORY")
2942@@ -163,6 +164,16 @@
2943
2944 def patch_yui_files_local_refs(doc_root_folder):
2945 data_file = os.path.join(doc_root_folder, "data.json")
2946- os.remove(data_file)
2947+ f = open(data_file,'r')
2948+ filedata = f.read()
2949+ f.close()
2950+
2951+ # Remove local files path, only leaving file names
2952+ newdata = re.sub(current_folder.replace('/doc', '')+'.*/', '', filedata)
2953+
2954+ f = open(data_file,'w')
2955+ f.write(newdata)
2956+ f.close()
2957
2958 patch_yui_files_docs(target_doc_directory)
2959+patch_yui_files_local_refs(target_doc_directory)

Subscribers

People subscribed via source and target branches

to all changes: