Project

General

Profile

Collection Schema » History » Version 1

Luke Murphey, 12/07/2016 11:20 PM

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 1 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 1 Luke Murphey
* *views:* A list indicating the views as part of the show. See below for a description of each entry
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.