Collection Schema » History » Version 3
Luke Murphey, 12/30/2016 08:02 AM
| 1 | 1 | Luke Murphey | h1. Collection Schema |
|---|---|---|---|
| 2 | 1 | Luke Murphey | |
| 3 | 1 | Luke Murphey | |_. Field |_. Description |_. Notes | |
| 4 | 1 | Luke Murphey | | _key | The key field | | |
| 5 | 1 | Luke Murphey | | configuration | A description of the show views and configuration. See below for details | | |
| 6 | 2 | Luke Murphey | | name | A simple string name for the show | | |
| 7 | 1 | Luke Murphey | |
| 8 | 1 | Luke Murphey | h2. Field: configuration |
| 9 | 1 | Luke Murphey | |
| 10 | 1 | Luke Murphey | This field is a JSON blob consisting of the following fields: |
| 11 | 1 | Luke Murphey | * *delay:* an integer indicator the number of seconds between each the transition of each view |
| 12 | 1 | Luke Murphey | * *delay_readable:* a readable version of the delay above. Includes the units (e.g. 1m) |
| 13 | 1 | Luke Murphey | * *invert_colors:* A boolean indicating the colors should be inverted |
| 14 | 1 | Luke Murphey | * *hide_chrome:* A boolean indicating whether the CSS should be shown or hidden |
| 15 | 3 | Luke Murphey | * *views:* A list indicating the views as part of the show. See below for a description of each entry. *(1)* |
| 16 | 1 | Luke Murphey | ** *app:* The app name with the view (e.g. search). This is the appid not the friendly name of the app. |
| 17 | 1 | Luke Murphey | ** *name:* The name of the view. |
| 18 | 3 | Luke Murphey | ** *url:* A URL to display in the show. |
| 19 | 3 | Luke Murphey | |
| 20 | 3 | Luke Murphey | *(1)* The entry should either be an entry with both the app _and_ name attributes, _or_ just a url attribute. |