← Back to branch summary

~zhangew401/scope-aggregator/fix-empty-query-to-clickstore

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Zhang Enwei
  • Date: 2016-08-04 01:21:42 UTC
  • mfrom: (169.1.3 scope-aggregator)
  • Revision ID: enwei.zhang@canonical.com-20160804012142-e670taahug3c1jqp
fix lp:1524597, support showing not install scopes by clickstore for keyword aggregators

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
473
473
        ]
474
474
        [...]
475
475
 
 
476
#### `keyword_scope_ids` key (optional)
 
477
 
 
478
Value: json list of objects.
 
479
 
 
480
This key is only used on the special clickstore scope declared with "id": "com.canonical.scopes.clickstore".
 
481
 
 
482
This clickstore scope displays scopes that are not installed and allows the user to install them.
 
483
 
 
484
By default, the clickstore scope (when declared) displays all child scopes declared in the child_scopes.json file by scope ID that are not currently installed.
 
485
 
 
486
This key allows the clickstore scope to also display scopes that are aggregated by keyword and that are not installed (in addition to scopes declared by ID and not installed, if any).
 
487
 
 
488
Example:
 
489
 
 
490
        [...]
 
491
        "scope":
 
492
        {
 
493
            "_category_title": "Install More Sources:",
 
494
            "id": "com.canonical.scopes.clickstore",
 
495
            "link_to_child": "true",                
 
496
            "local_id": "com.canonical.scopes.clickstore",
 
497
            "department": "dept-movies",
 
498
            "cardinality": 10,
 
499
            "sources":[
 
500
                {
 
501
                    "id": "com.canonical.scopes.eros_eros"
 
502
                },
 
503
                {
 
504
                    "id": "com.canonical.scopes.hotstar_hotstar"
 
505
                },
 
506
                {
 
507
                    "id": "com.canonical.scopes.timesofindia_timesofindia"
 
508
                },
 
509
                {
 
510
                    "id": "com.canonical.scopes.shemaroo_shemaroo"
 
511
                },
 
512
                {
 
513
                    "id": "com.canonical.scopes.zeetv_zeetv"
 
514
                }
 
515
            ]
 
516
        }
 
517
        [...]
 
518
 
 
519
Example with no `keyword_scope_ids`:
 
520
 
 
521
        [...]
 
522
        "scope":
 
523
        {
 
524
            "_category_title": "Install More Sources:",
 
525
            "id": "com.canonical.scopes.clickstore",
 
526
            "link_to_child": "true",
 
527
            "local_id": "com.canonical.scopes.clickstore",
 
528
            "department": "dept-movies",
 
529
            "cardinality": 10,
 
530
        }
 
531
        [...]
 
532
 
476
533
### `keyword` (optional)
477
534
 
478
535
Declare a specific keyword for aggregation.