archives/pebble
2
0
Fork 0
mirror of https://github.com/google/pebble.git synced 2025-03-15 08:41:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
pebble/devsite/source/_data/jsdocs-pkjs.json
Katharine Berry 527858cf4c Import the pebble dev site into devsite/
2025-02-24 18:58:29 -08:00

12192 lines
No EOL
399 KiB
JSON
Raw Permalink Blame History

[
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The Pebble namespace is where all of the Pebble specific methods and \nproperties exist. This class contains methods belonging to PebbleKit JS and \nallows bi-directional communication with a C or JavaScript watchapp, as well as managing \nthe user's timeline subscriptions, creating AppGlance slices and obtaining \ninformation about the currently connected watch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 49,
"offset": 361
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 49,
"offset": 361
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 49,
"offset": 361
}
}
},
"tags": [
{
"title": "namespace",
"description": null,
"lineNumber": 1,
"type": null,
"name": "Pebble"
},
{
"title": "desc",
"description": "The Pebble namespace is where all of the Pebble specific methods and \nproperties exist. This class contains methods belonging to PebbleKit JS and \nallows bi-directional communication with a C or JavaScript watchapp, as well as managing \nthe user's timeline subscriptions, creating AppGlance slices and obtaining \ninformation about the currently connected watch.",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 9,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 10,
"column": 0
},
"end": {
"line": 10,
"column": 24
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "namespace",
"name": "Pebble",
"members": {
"instance": [],
"static": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Adds a listener for PebbleKit JS events, such as when an ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 58,
"offset": 57
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "AppMessage",
"position": {
"start": {
"line": 1,
"column": 58,
"offset": 57
},
"end": {
"line": 1,
"column": 72,
"offset": 71
},
"indent": []
}
},
{
"type": "text",
"value": " is\n received or the configuration view is opened or closed.",
"position": {
"start": {
"line": 1,
"column": 72,
"offset": 71
},
"end": {
"line": 2,
"column": 60,
"offset": 134
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 60,
"offset": 134
},
"indent": [
1
]
}
},
{
"type": "heading",
"depth": 4,
"children": [
{
"type": "text",
"value": "Event Type Options",
"position": {
"start": {
"line": 4,
"column": 8,
"offset": 143
},
"end": {
"line": 4,
"column": 26,
"offset": 161
},
"indent": []
}
}
],
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 136
},
"end": {
"line": 4,
"column": 26,
"offset": 161
},
"indent": []
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": " Possible values:",
"position": {
"start": {
"line": 6,
"column": 1,
"offset": 163
},
"end": {
"line": 6,
"column": 19,
"offset": 181
},
"indent": []
}
}
],
"position": {
"start": {
"line": 6,
"column": 1,
"offset": 163
},
"end": {
"line": 6,
"column": 19,
"offset": 181
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "ready",
"position": {
"start": {
"line": 8,
"column": 5,
"offset": 187
},
"end": {
"line": 8,
"column": 12,
"offset": 194
},
"indent": []
}
},
{
"type": "text",
"value": " - The watchapp has been launched and the PebbleKit JS component \nis now ready to receive events.",
"position": {
"start": {
"line": 8,
"column": 12,
"offset": 194
},
"end": {
"line": 9,
"column": 36,
"offset": 295
},
"indent": [
5
]
}
}
],
"position": {
"start": {
"line": 8,
"column": 5,
"offset": 187
},
"end": {
"line": 9,
"column": 36,
"offset": 295
},
"indent": [
5
]
}
}
],
"position": {
"start": {
"line": 8,
"column": 1,
"offset": 183
},
"end": {
"line": 9,
"column": 36,
"offset": 295
},
"indent": [
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "appmessage",
"position": {
"start": {
"line": 10,
"column": 5,
"offset": 300
},
"end": {
"line": 10,
"column": 17,
"offset": 312
},
"indent": []
}
},
{
"type": "text",
"value": " - The watch sent an ",
"position": {
"start": {
"line": 10,
"column": 17,
"offset": 312
},
"end": {
"line": 10,
"column": 38,
"offset": 333
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "AppMessage",
"position": {
"start": {
"line": 10,
"column": 38,
"offset": 333
},
"end": {
"line": 10,
"column": 52,
"offset": 347
},
"indent": []
}
},
{
"type": "text",
"value": " to PebbleKit JS. The \nAppMessage ",
"position": {
"start": {
"line": 10,
"column": 52,
"offset": 347
},
"end": {
"line": 11,
"column": 16,
"offset": 385
},
"indent": [
5
]
}
},
{
"type": "inlineCode",
"value": "Dictionary",
"position": {
"start": {
"line": 11,
"column": 16,
"offset": 385
},
"end": {
"line": 11,
"column": 30,
"offset": 399
},
"indent": []
}
},
{
"type": "text",
"value": " is contained in the payload property (i.e: \n",
"position": {
"start": {
"line": 11,
"column": 30,
"offset": 399
},
"end": {
"line": 12,
"column": 5,
"offset": 448
},
"indent": [
5
]
}
},
{
"type": "inlineCode",
"value": "event.payload",
"position": {
"start": {
"line": 12,
"column": 5,
"offset": 448
},
"end": {
"line": 12,
"column": 20,
"offset": 463
},
"indent": []
}
},
{
"type": "text",
"value": "). The payload consists of key-value pairs, where the keys \nare strings containing integers (e.g: \"0\"), or aliases for keys defined \nin package.json (e.g: \"KEY_EXAMPLE\"). Values should be integers, strings \nor byte arrays (arrays of characters). This event is not available to \n",
"position": {
"start": {
"line": 12,
"column": 20,
"offset": 463
},
"end": {
"line": 16,
"column": 5,
"offset": 757
},
"indent": [
5,
5,
5,
5
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 16,
"column": 5,
"offset": 757
},
"end": {
"line": 16,
"column": 36,
"offset": 788
},
"indent": []
}
},
{
"type": "text",
"value": " applications, and attempting to register it will throw an exception.",
"position": {
"start": {
"line": 16,
"column": 36,
"offset": 788
},
"end": {
"line": 16,
"column": 105,
"offset": 857
},
"indent": []
}
}
],
"position": {
"start": {
"line": 10,
"column": 5,
"offset": 300
},
"end": {
"line": 16,
"column": 105,
"offset": 857
},
"indent": [
5,
5,
5,
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 10,
"column": 1,
"offset": 296
},
"end": {
"line": 16,
"column": 105,
"offset": 857
},
"indent": [
1,
1,
1,
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "showConfiguration",
"position": {
"start": {
"line": 17,
"column": 5,
"offset": 862
},
"end": {
"line": 17,
"column": 24,
"offset": 881
},
"indent": []
}
},
{
"type": "text",
"value": " - The user has requested the app's configuration \nwebview to be displayed. This can occur either upon the app's initial \ninstall or when the user taps 'Settings' in the 'My Pebble' view within \nthe phone app.",
"position": {
"start": {
"line": 17,
"column": 24,
"offset": 881
},
"end": {
"line": 20,
"column": 19,
"offset": 1102
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 17,
"column": 5,
"offset": 862
},
"end": {
"line": 20,
"column": 19,
"offset": 1102
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 17,
"column": 1,
"offset": 858
},
"end": {
"line": 20,
"column": 19,
"offset": 1102
},
"indent": [
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "webviewclosed",
"position": {
"start": {
"line": 21,
"column": 5,
"offset": 1107
},
"end": {
"line": 21,
"column": 20,
"offset": 1122
},
"indent": []
}
},
{
"type": "text",
"value": " - The configuration webview was closed by the user. If \nthe webview had a response, it will be contained in the response property \n(i.e: ",
"position": {
"start": {
"line": 21,
"column": 20,
"offset": 1122
},
"end": {
"line": 23,
"column": 11,
"offset": 1268
},
"indent": [
5,
5
]
}
},
{
"type": "inlineCode",
"value": "event.response",
"position": {
"start": {
"line": 23,
"column": 11,
"offset": 1268
},
"end": {
"line": 23,
"column": 27,
"offset": 1284
},
"indent": []
}
},
{
"type": "text",
"value": "). This response can be used to feed back user \npreferences to the watchapp.",
"position": {
"start": {
"line": 23,
"column": 27,
"offset": 1284
},
"end": {
"line": 24,
"column": 33,
"offset": 1364
},
"indent": [
5
]
}
}
],
"position": {
"start": {
"line": 21,
"column": 5,
"offset": 1107
},
"end": {
"line": 24,
"column": 33,
"offset": 1364
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 21,
"column": 1,
"offset": 1103
},
"end": {
"line": 24,
"column": 33,
"offset": 1364
},
"indent": [
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "message",
"position": {
"start": {
"line": 25,
"column": 5,
"offset": 1369
},
"end": {
"line": 25,
"column": 14,
"offset": 1378
},
"indent": []
}
},
{
"type": "text",
"value": " - Provide a ",
"position": {
"start": {
"line": 25,
"column": 14,
"offset": 1378
},
"end": {
"line": 25,
"column": 27,
"offset": 1391
},
"indent": []
}
},
{
"type": "link",
"url": "#PostMessageCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "PostMessageCallback"
}
],
"position": {
"start": {
"line": 25,
"column": 27,
"offset": 1391
},
"end": {
"line": 25,
"column": 75,
"offset": 1439
},
"indent": []
}
},
{
"type": "text",
"value": " \nas the callback. The message event is emitted every time PebbleKit JS \nreceives a ",
"position": {
"start": {
"line": 25,
"column": 75,
"offset": 1439
},
"end": {
"line": 27,
"column": 16,
"offset": 1531
},
"indent": [
5,
5
]
}
},
{
"type": "link",
"url": "#postMessage",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "postMessage"
}
],
"position": {
"start": {
"line": 27,
"column": 16,
"offset": 1531
},
"end": {
"line": 27,
"column": 48,
"offset": 1563
},
"indent": []
}
},
{
"type": "text",
"value": " from the ",
"position": {
"start": {
"line": 27,
"column": 48,
"offset": 1563
},
"end": {
"line": 27,
"column": 58,
"offset": 1573
},
"indent": []
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 27,
"column": 58,
"offset": 1573
},
"end": {
"line": 27,
"column": 89,
"offset": 1604
},
"indent": []
}
},
{
"type": "break",
"position": {
"start": {
"line": 27,
"column": 89,
"offset": 1604
},
"end": {
"line": 28,
"column": 5,
"offset": 1611
},
"indent": [
5
]
}
},
{
"type": "text",
"value": " application. The payload contains a simple JavaScript object. (i.e. ",
"position": {
"start": {
"line": 28,
"column": 5,
"offset": 1611
},
"end": {
"line": 28,
"column": 74,
"offset": 1680
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "event.data",
"position": {
"start": {
"line": 28,
"column": 74,
"offset": 1680
},
"end": {
"line": 28,
"column": 86,
"offset": 1692
},
"indent": []
}
},
{
"type": "text",
"value": "). \nThis event type can only be used with ",
"position": {
"start": {
"line": 28,
"column": 86,
"offset": 1692
},
"end": {
"line": 29,
"column": 43,
"offset": 1738
},
"indent": [
5
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 29,
"column": 43,
"offset": 1738
},
"end": {
"line": 29,
"column": 74,
"offset": 1769
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 29,
"column": 74,
"offset": 1769
},
"end": {
"line": 29,
"column": 88,
"offset": 1783
},
"indent": []
}
}
],
"position": {
"start": {
"line": 25,
"column": 5,
"offset": 1369
},
"end": {
"line": 29,
"column": 88,
"offset": 1783
},
"indent": [
5,
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 25,
"column": 1,
"offset": 1365
},
"end": {
"line": 29,
"column": 88,
"offset": 1783
},
"indent": [
1,
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "postmessageconnected",
"position": {
"start": {
"line": 30,
"column": 5,
"offset": 1788
},
"end": {
"line": 30,
"column": 27,
"offset": 1810
},
"indent": []
}
},
{
"type": "text",
"value": " - Provide a ",
"position": {
"start": {
"line": 30,
"column": 27,
"offset": 1810
},
"end": {
"line": 30,
"column": 40,
"offset": 1823
},
"indent": []
}
},
{
"type": "link",
"url": "#PostMessageConnectedCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "PostMessageConnectedCallback"
}
],
"position": {
"start": {
"line": 30,
"column": 40,
"offset": 1823
},
"end": {
"line": 30,
"column": 106,
"offset": 1889
},
"indent": []
}
},
{
"type": "text",
"value": " \nas the callback. The event may be emitted immediately upon subscription, \nif the subsystem is already connected. It is also emitted when connectivity is established. \nThis event type can only be used with ",
"position": {
"start": {
"line": 30,
"column": 106,
"offset": 1889
},
"end": {
"line": 33,
"column": 43,
"offset": 2108
},
"indent": [
5,
5,
5
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 33,
"column": 43,
"offset": 2108
},
"end": {
"line": 33,
"column": 74,
"offset": 2139
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 33,
"column": 74,
"offset": 2139
},
"end": {
"line": 33,
"column": 88,
"offset": 2153
},
"indent": []
}
}
],
"position": {
"start": {
"line": 30,
"column": 5,
"offset": 1788
},
"end": {
"line": 33,
"column": 88,
"offset": 2153
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 30,
"column": 1,
"offset": 1784
},
"end": {
"line": 33,
"column": 88,
"offset": 2153
},
"indent": [
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "postmessagedisconnected",
"position": {
"start": {
"line": 34,
"column": 5,
"offset": 2158
},
"end": {
"line": 34,
"column": 30,
"offset": 2183
},
"indent": []
}
},
{
"type": "text",
"value": " - Provide a ",
"position": {
"start": {
"line": 34,
"column": 30,
"offset": 2183
},
"end": {
"line": 34,
"column": 43,
"offset": 2196
},
"indent": []
}
},
{
"type": "link",
"url": "#PostMessageDisconnectedCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "PostMessageDisconnectedCallback"
}
],
"position": {
"start": {
"line": 34,
"column": 43,
"offset": 2196
},
"end": {
"line": 34,
"column": 115,
"offset": 2268
},
"indent": []
}
},
{
"type": "text",
"value": " \nas the callback. The event may be emitted immediately upon subscription, \nif the subsystem is already disconnected. It is also emitted when connectivity is lost. \nThis event type can only be used with ",
"position": {
"start": {
"line": 34,
"column": 115,
"offset": 2268
},
"end": {
"line": 37,
"column": 43,
"offset": 2483
},
"indent": [
5,
5,
5
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 37,
"column": 43,
"offset": 2483
},
"end": {
"line": 37,
"column": 74,
"offset": 2514
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 37,
"column": 74,
"offset": 2514
},
"end": {
"line": 37,
"column": 88,
"offset": 2528
},
"indent": []
}
}
],
"position": {
"start": {
"line": 34,
"column": 5,
"offset": 2158
},
"end": {
"line": 37,
"column": 88,
"offset": 2528
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 34,
"column": 1,
"offset": 2154
},
"end": {
"line": 37,
"column": 88,
"offset": 2528
},
"indent": [
1,
1,
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "postmessageerror",
"position": {
"start": {
"line": 38,
"column": 5,
"offset": 2533
},
"end": {
"line": 38,
"column": 23,
"offset": 2551
},
"indent": []
}
},
{
"type": "text",
"value": " - Provide a ",
"position": {
"start": {
"line": 38,
"column": 23,
"offset": 2551
},
"end": {
"line": 38,
"column": 36,
"offset": 2564
},
"indent": []
}
},
{
"type": "link",
"url": "#PostMessageErrorCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "PostMessageErrorCallback"
}
],
"position": {
"start": {
"line": 38,
"column": 36,
"offset": 2564
},
"end": {
"line": 38,
"column": 94,
"offset": 2622
},
"indent": []
}
},
{
"type": "text",
"value": " \nas the callback. The event is emitted when a transmission error occurrs. \nYour message has not been delivered. The type of error is not provided. \nThis event type can only be used with ",
"position": {
"start": {
"line": 38,
"column": 94,
"offset": 2622
},
"end": {
"line": 41,
"column": 43,
"offset": 2821
},
"indent": [
5,
5,
5
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 41,
"column": 43,
"offset": 2821
},
"end": {
"line": 41,
"column": 74,
"offset": 2852
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 41,
"column": 74,
"offset": 2852
},
"end": {
"line": 41,
"column": 88,
"offset": 2866
},
"indent": []
}
}
],
"position": {
"start": {
"line": 38,
"column": 5,
"offset": 2533
},
"end": {
"line": 41,
"column": 88,
"offset": 2866
},
"indent": [
5,
5,
5
]
}
}
],
"position": {
"start": {
"line": 38,
"column": 1,
"offset": 2529
},
"end": {
"line": 41,
"column": 88,
"offset": 2866
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 8,
"column": 1,
"offset": 183
},
"end": {
"line": 41,
"column": 88,
"offset": 2866
},
"indent": [
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 41,
"column": 88,
"offset": 2866
}
}
},
"tags": [
{
"title": "desc",
"description": "Adds a listener for PebbleKit JS events, such as when an ``AppMessage`` is\n received or the configuration view is opened or closed.\n\n #### Event Type Options\n\n Possible values:\n\n * `ready` - The watchapp has been launched and the PebbleKit JS component \n is now ready to receive events.\n * `appmessage` - The watch sent an ``AppMessage`` to PebbleKit JS. The \n AppMessage ``Dictionary`` is contained in the payload property (i.e: \n `event.payload`). The payload consists of key-value pairs, where the keys \n are strings containing integers (e.g: \"0\"), or aliases for keys defined \n in package.json (e.g: \"KEY_EXAMPLE\"). Values should be integers, strings \n or byte arrays (arrays of characters). This event is not available to \n {@link /docs/rockyjs/ Rocky.js} applications, and attempting to register it will throw an exception.\n * `showConfiguration` - The user has requested the app's configuration \n webview to be displayed. This can occur either upon the app's initial \n install or when the user taps 'Settings' in the 'My Pebble' view within \n the phone app.\n * `webviewclosed` - The configuration webview was closed by the user. If \n the webview had a response, it will be contained in the response property \n (i.e: `event.response`). This response can be used to feed back user \n preferences to the watchapp.\n * `message` - Provide a {@link #PostMessageCallback PostMessageCallback} \n as the callback. The message event is emitted every time PebbleKit JS \n receives a {@link #postMessage postMessage} from the {@link /docs/rockyjs/ Rocky.js} \n application. The payload contains a simple JavaScript object. (i.e. `event.data`). \n This event type can only be used with {@link /docs/rockyjs/ Rocky.js} applications.\n * `postmessageconnected` - Provide a {@link #PostMessageConnectedCallback PostMessageConnectedCallback} \n as the callback. The event may be emitted immediately upon subscription, \n if the subsystem is already connected. It is also emitted when connectivity is established. \n This event type can only be used with {@link /docs/rockyjs/ Rocky.js} applications.\n * `postmessagedisconnected` - Provide a {@link #PostMessageDisconnectedCallback PostMessageDisconnectedCallback} \n as the callback. The event may be emitted immediately upon subscription, \n if the subsystem is already disconnected. It is also emitted when connectivity is lost. \n This event type can only be used with {@link /docs/rockyjs/ Rocky.js} applications.\n * `postmessageerror` - Provide a {@link #PostMessageErrorCallback PostMessageErrorCallback} \n as the callback. The event is emitted when a transmission error occurrs. \n Your message has not been delivered. The type of error is not provided. \n This event type can only be used with {@link /docs/rockyjs/ Rocky.js} applications.",
"lineNumber": 1
},
{
"title": "param",
"description": "The type of the event, from the list described above.",
"lineNumber": 43,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "type"
},
{
"title": "param",
"description": "The developer defined {@link #EventCallback EventCallback} \n to receive any events of the type specified that occur.",
"lineNumber": 44,
"type": {
"type": "NameExpression",
"name": "EventCallback"
},
"name": "callback"
}
],
"loc": {
"start": {
"line": 13,
"column": 0
},
"end": {
"line": 59,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 60,
"column": 0
},
"end": {
"line": 60,
"column": 55
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "type",
"lineNumber": 43,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The type of the event, from the list described above.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "callback",
"lineNumber": 44,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer defined ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 23,
"offset": 22
},
"indent": []
}
},
{
"type": "link",
"url": "#EventCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "EventCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 23,
"offset": 22
},
"end": {
"line": 1,
"column": 59,
"offset": 58
},
"indent": []
}
},
{
"type": "text",
"value": " \n to receive any events of the type specified that occur.",
"position": {
"start": {
"line": 1,
"column": 59,
"offset": 58
},
"end": {
"line": 2,
"column": 58,
"offset": 117
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 58,
"offset": 117
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 58,
"offset": 117
}
}
},
"type": {
"type": "NameExpression",
"name": "EventCallback"
}
}
],
"name": "addEventListener",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "addEventListener",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.addEventListener"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Attaches an event handler to the specified events. Synonymous with \n",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 1,
"offset": 68
},
"indent": [
1
]
}
},
{
"type": "link",
"title": null,
"url": "#addEventListener",
"children": [
{
"type": "text",
"value": "Pebble.addEventListener()",
"position": {
"start": {
"line": 2,
"column": 2,
"offset": 69
},
"end": {
"line": 2,
"column": 27,
"offset": 94
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 68
},
"end": {
"line": 2,
"column": 47,
"offset": 114
},
"indent": []
}
},
{
"type": "text",
"value": ". Only applicable to \n",
"position": {
"start": {
"line": 2,
"column": 47,
"offset": 114
},
"end": {
"line": 3,
"column": 1,
"offset": 136
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 136
},
"end": {
"line": 3,
"column": 32,
"offset": 167
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 3,
"column": 32,
"offset": 167
},
"end": {
"line": 3,
"column": 46,
"offset": 181
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 46,
"offset": 181
},
"indent": [
1,
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "Pebble.on(type, callback);",
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 183
},
"end": {
"line": 5,
"column": 29,
"offset": 211
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 183
},
"end": {
"line": 5,
"column": 29,
"offset": 211
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 29,
"offset": 211
}
}
},
"tags": [
{
"title": "desc",
"description": "Attaches an event handler to the specified events. Synonymous with \n[Pebble.addEventListener()](#addEventListener). Only applicable to \n{@link /docs/rockyjs/ Rocky.js} applications.\n\n`Pebble.on(type, callback);`",
"lineNumber": 1
},
{
"title": "param",
"description": "The type of the event, from the list described above.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "type"
},
{
"title": "param",
"description": "The developer defined {@link #EventCallback EventCallback}\n to receive any events of the type specified that occur.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "EventCallback"
},
"name": "callback"
}
],
"loc": {
"start": {
"line": 62,
"column": 0
},
"end": {
"line": 72,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 73,
"column": 0
},
"end": {
"line": 73,
"column": 41
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "type",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The type of the event, from the list described above.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 54,
"offset": 53
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "callback",
"lineNumber": 8,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer defined ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 23,
"offset": 22
},
"indent": []
}
},
{
"type": "link",
"url": "#EventCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "EventCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 23,
"offset": 22
},
"end": {
"line": 1,
"column": 59,
"offset": 58
},
"indent": []
}
},
{
"type": "text",
"value": "\n to receive any events of the type specified that occur.",
"position": {
"start": {
"line": 1,
"column": 59,
"offset": 58
},
"end": {
"line": 2,
"column": 58,
"offset": 116
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 58,
"offset": 116
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 58,
"offset": 116
}
}
},
"type": {
"type": "NameExpression",
"name": "EventCallback"
}
}
],
"name": "on",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "on",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.on"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Remove an existing event listener previously registered with \n ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 3,
"offset": 64
},
"indent": [
1
]
}
},
{
"type": "link",
"title": null,
"url": "#addEventListener",
"children": [
{
"type": "text",
"value": "Pebble.addEventListener()",
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 65
},
"end": {
"line": 2,
"column": 29,
"offset": 90
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 3,
"offset": 64
},
"end": {
"line": 2,
"column": 49,
"offset": 110
},
"indent": []
}
},
{
"type": "text",
"value": " or ",
"position": {
"start": {
"line": 2,
"column": 49,
"offset": 110
},
"end": {
"line": 2,
"column": 53,
"offset": 114
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "#on",
"children": [
{
"type": "text",
"value": "Pebble.on()",
"position": {
"start": {
"line": 2,
"column": 54,
"offset": 115
},
"end": {
"line": 2,
"column": 65,
"offset": 126
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 53,
"offset": 114
},
"end": {
"line": 2,
"column": 71,
"offset": 132
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 71,
"offset": 132
},
"end": {
"line": 2,
"column": 72,
"offset": 133
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 72,
"offset": 133
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 72,
"offset": 133
}
}
},
"tags": [
{
"title": "desc",
"description": "Remove an existing event listener previously registered with \n [Pebble.addEventListener()](#addEventListener) or [Pebble.on()](#on).",
"lineNumber": 1
},
{
"title": "param",
"description": "The type of the event listener to be removed. See \n [Pebble.addEventListener()](#addEventListener) for a list of available event types.",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "type"
},
{
"title": "param",
"description": "The existing developer-defined function that was \n previously registered.",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "callback"
}
],
"loc": {
"start": {
"line": 75,
"column": 0
},
"end": {
"line": 83,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 84,
"column": 0
},
"end": {
"line": 84,
"column": 58
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "type",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The type of the event listener to be removed. See \n ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 3,
"offset": 53
},
"indent": [
1
]
}
},
{
"type": "link",
"title": null,
"url": "#addEventListener",
"children": [
{
"type": "text",
"value": "Pebble.addEventListener()",
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 54
},
"end": {
"line": 2,
"column": 29,
"offset": 79
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 3,
"offset": 53
},
"end": {
"line": 2,
"column": 49,
"offset": 99
},
"indent": []
}
},
{
"type": "text",
"value": " for a list of available event types.",
"position": {
"start": {
"line": 2,
"column": 49,
"offset": 99
},
"end": {
"line": 2,
"column": 86,
"offset": 136
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 86,
"offset": 136
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 86,
"offset": 136
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "callback",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The existing developer-defined function that was \n previously registered.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "removeEventListener",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "removeEventListener",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.removeEventListener"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Remove an existing event handler from the specified events. Synonymous \n with ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 13,
"offset": 84
},
"indent": [
1
]
}
},
{
"type": "link",
"title": null,
"url": "#removeEventListener",
"children": [
{
"type": "text",
"value": "Pebble.removeEventListener()",
"position": {
"start": {
"line": 2,
"column": 14,
"offset": 85
},
"end": {
"line": 2,
"column": 42,
"offset": 113
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 13,
"offset": 84
},
"end": {
"line": 2,
"column": 65,
"offset": 136
},
"indent": []
}
},
{
"type": "text",
"value": ". Only applicable to \n ",
"position": {
"start": {
"line": 2,
"column": 65,
"offset": 136
},
"end": {
"line": 3,
"column": 7,
"offset": 164
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 3,
"column": 7,
"offset": 164
},
"end": {
"line": 3,
"column": 38,
"offset": 195
},
"indent": []
}
},
{
"type": "text",
"value": " applications.",
"position": {
"start": {
"line": 3,
"column": 38,
"offset": 195
},
"end": {
"line": 3,
"column": 52,
"offset": 209
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 52,
"offset": 209
},
"indent": [
1,
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "Pebble.off(type, callback);",
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 211
},
"end": {
"line": 5,
"column": 30,
"offset": 240
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 211
},
"end": {
"line": 5,
"column": 30,
"offset": 240
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 30,
"offset": 240
}
}
},
"tags": [
{
"title": "desc",
"description": "Remove an existing event handler from the specified events. Synonymous \n with [Pebble.removeEventListener()](#removeEventListener). Only applicable to \n {@link /docs/rockyjs/ Rocky.js} applications.\n\n`Pebble.off(type, callback);`",
"lineNumber": 1
},
{
"title": "param",
"description": "The type of the event listener to be removed. See \n [Pebble.addEventListener()](#addEventListener) for a list of available types.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "type"
},
{
"title": "param",
"description": "The existing developer-defined function that was \n previously registered.",
"lineNumber": 9,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "callback"
}
],
"loc": {
"start": {
"line": 86,
"column": 0
},
"end": {
"line": 97,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 98,
"column": 0
},
"end": {
"line": 98,
"column": 42
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "type",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The type of the event listener to be removed. See \n ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 3,
"offset": 53
},
"indent": [
1
]
}
},
{
"type": "link",
"title": null,
"url": "#addEventListener",
"children": [
{
"type": "text",
"value": "Pebble.addEventListener()",
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 54
},
"end": {
"line": 2,
"column": 29,
"offset": 79
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 3,
"offset": 53
},
"end": {
"line": 2,
"column": 49,
"offset": 99
},
"indent": []
}
},
{
"type": "text",
"value": " for a list of available types.",
"position": {
"start": {
"line": 2,
"column": 49,
"offset": 99
},
"end": {
"line": 2,
"column": 80,
"offset": 130
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 80,
"offset": 130
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 80,
"offset": 130
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "callback",
"lineNumber": 9,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The existing developer-defined function that was \n previously registered.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 25,
"offset": 74
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "off",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "off",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.off"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Show a simple modal notification on the connected watch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
}
}
},
"tags": [
{
"title": "desc",
"description": "Show a simple modal notification on the connected watch.",
"lineNumber": 1
},
{
"title": "param",
"description": "The title of the notification",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "title"
},
{
"title": "param",
"description": "The main content of the notification",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "body"
}
],
"loc": {
"start": {
"line": 100,
"column": 0
},
"end": {
"line": 105,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 106,
"column": 0
},
"end": {
"line": 106,
"column": 66
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "title",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The title of the notification",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 30,
"offset": 29
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "body",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The main content of the notification",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 37,
"offset": 36
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"name": "showSimpleNotificationOnPebble",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "showSimpleNotificationOnPebble",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.showSimpleNotificationOnPebble"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Send an AppMessage to the app running on the watch. Messages should be \n in the form of JSON objects containing key-value pairs. See \n Pebble.sendAppMessage() for valid key and value data types. \n ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 5,
"offset": 206
},
"indent": [
1,
1,
1
]
}
},
{
"type": "inlineCode",
"value": "Pebble.sendAppMessage = function(data, onSuccess, onFailure) { };",
"position": {
"start": {
"line": 4,
"column": 5,
"offset": 206
},
"end": {
"line": 4,
"column": 72,
"offset": 273
},
"indent": []
}
},
{
"type": "text",
"value": " \n Please note that ",
"position": {
"start": {
"line": 4,
"column": 72,
"offset": 273
},
"end": {
"line": 5,
"column": 22,
"offset": 296
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "sendAppMessage",
"position": {
"start": {
"line": 5,
"column": 22,
"offset": 296
},
"end": {
"line": 5,
"column": 38,
"offset": 312
},
"indent": []
}
},
{
"type": "text",
"value": " is ",
"position": {
"start": {
"line": 5,
"column": 38,
"offset": 312
},
"end": {
"line": 5,
"column": 42,
"offset": 316
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "undefined",
"position": {
"start": {
"line": 5,
"column": 42,
"offset": 316
},
"end": {
"line": 5,
"column": 53,
"offset": 327
},
"indent": []
}
},
{
"type": "text",
"value": " in \n ",
"position": {
"start": {
"line": 5,
"column": 53,
"offset": 327
},
"end": {
"line": 6,
"column": 5,
"offset": 336
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 6,
"column": 5,
"offset": 336
},
"end": {
"line": 6,
"column": 36,
"offset": 367
},
"indent": []
}
},
{
"type": "text",
"value": " applications, see ",
"position": {
"start": {
"line": 6,
"column": 36,
"offset": 367
},
"end": {
"line": 6,
"column": 55,
"offset": 386
},
"indent": []
}
},
{
"type": "link",
"url": "#postMessage",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "postMessage"
}
],
"position": {
"start": {
"line": 6,
"column": 55,
"offset": 386
},
"end": {
"line": 6,
"column": 87,
"offset": 418
},
"indent": []
}
},
{
"type": "text",
"value": " instead.",
"position": {
"start": {
"line": 6,
"column": 87,
"offset": 418
},
"end": {
"line": 6,
"column": 96,
"offset": 427
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 96,
"offset": 427
},
"indent": [
1,
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 96,
"offset": 427
}
}
},
"tags": [
{
"title": "desc",
"description": "Send an AppMessage to the app running on the watch. Messages should be \n in the form of JSON objects containing key-value pairs. See \n Pebble.sendAppMessage() for valid key and value data types. \n `Pebble.sendAppMessage = function(data, onSuccess, onFailure) { };` \n Please note that `sendAppMessage` is `undefined` in \n {@link /docs/rockyjs/ Rocky.js} applications, see {@link #postMessage postMessage} instead.",
"lineNumber": 1
},
{
"title": "returns",
"description": "The transaction id for this message",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "Number"
}
},
{
"title": "param",
"description": "A JSON object containing key-value pairs to send to \n the watch. Values in arrays that are greater then 255 will be mod 255 \n before sending.",
"lineNumber": 10,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "data"
},
{
"title": "param",
"description": "A developer-defined {@link #AppMessageAckCallback AppMessageAckCallback} \n callback to run if the watch acknowledges (ACK) this message.",
"lineNumber": 13,
"type": {
"type": "NameExpression",
"name": "AppMessageAckCallback"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "A developer-defined {@link #AppMessageNackCallback AppMessageNackCallback} \n callback to run if the watch does NOT acknowledge (NACK) this message.",
"lineNumber": 15,
"type": {
"type": "NameExpression",
"name": "AppMessageOnFailure"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 108,
"column": 0
},
"end": {
"line": 125,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 126,
"column": 0
},
"end": {
"line": 126,
"column": 65
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The transaction id for this message",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 36,
"offset": 35
}
}
},
"type": {
"type": "NameExpression",
"name": "Number"
}
}
],
"params": [
{
"name": "data",
"lineNumber": 10,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A JSON object containing key-value pairs to send to \n the watch. Values in arrays that are greater then 255 will be mod 255 \n before sending.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 20,
"offset": 147
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 20,
"offset": 147
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 20,
"offset": 147
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
},
{
"name": "onSuccess",
"lineNumber": 13,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
},
{
"type": "link",
"url": "#AppMessageAckCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "AppMessageAckCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 21,
"offset": 20
},
"end": {
"line": 1,
"column": 73,
"offset": 72
},
"indent": []
}
},
{
"type": "text",
"value": " \n callback to run if the watch acknowledges (ACK) this message.",
"position": {
"start": {
"line": 1,
"column": 73,
"offset": 72
},
"end": {
"line": 2,
"column": 66,
"offset": 139
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 139
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 139
}
}
},
"type": {
"type": "NameExpression",
"name": "AppMessageAckCallback"
}
},
{
"name": "onFailure",
"lineNumber": 15,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
},
{
"type": "link",
"url": "#AppMessageNackCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "AppMessageNackCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 21,
"offset": 20
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
},
{
"type": "text",
"value": " \n callback to run if the watch does NOT acknowledge (NACK) this message.",
"position": {
"start": {
"line": 1,
"column": 75,
"offset": 74
},
"end": {
"line": 2,
"column": 75,
"offset": 150
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 75,
"offset": 150
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 75,
"offset": 150
}
}
},
"type": {
"type": "NameExpression",
"name": "AppMessageOnFailure"
}
}
],
"name": "sendAppMessage",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "sendAppMessage",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.sendAppMessage"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Sends a message to the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 24,
"offset": 23
},
"indent": []
}
},
{
"type": "link",
"url": "/docs/rockyjs/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "Rocky.js"
}
],
"position": {
"start": {
"line": 1,
"column": 24,
"offset": 23
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
},
{
"type": "text",
"value": " component. Please be aware \n that messages should be kept concise. Each message is queued, so \n ",
"position": {
"start": {
"line": 1,
"column": 55,
"offset": 54
},
"end": {
"line": 3,
"column": 4,
"offset": 155
},
"indent": [
1,
1
]
}
},
{
"type": "inlineCode",
"value": "postMessage()",
"position": {
"start": {
"line": 3,
"column": 4,
"offset": 155
},
"end": {
"line": 3,
"column": 19,
"offset": 170
},
"indent": []
}
},
{
"type": "text",
"value": " can be called multiple times immediately. If there is a momentary loss of connectivity, queued \n messages may still be delivered, or automatically removed from the queue \n after a few seconds of failed connectivity. Any transmission failures, or \n out of memory errors will be raised via the ",
"position": {
"start": {
"line": 3,
"column": 19,
"offset": 170
},
"end": {
"line": 6,
"column": 48,
"offset": 469
},
"indent": [
1,
1,
1
]
}
},
{
"type": "inlineCode",
"value": "postmessageerror",
"position": {
"start": {
"line": 6,
"column": 48,
"offset": 469
},
"end": {
"line": 6,
"column": 66,
"offset": 487
},
"indent": []
}
},
{
"type": "text",
"value": " event.",
"position": {
"start": {
"line": 6,
"column": 66,
"offset": 487
},
"end": {
"line": 6,
"column": 73,
"offset": 494
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 73,
"offset": 494
},
"indent": [
1,
1,
1,
1,
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "Pebble.postMessage({temperature: 30, conditions: 'Sunny'});",
"position": {
"start": {
"line": 8,
"column": 1,
"offset": 496
},
"end": {
"line": 8,
"column": 62,
"offset": 557
},
"indent": []
}
}
],
"position": {
"start": {
"line": 8,
"column": 1,
"offset": 496
},
"end": {
"line": 8,
"column": 62,
"offset": 557
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 8,
"column": 62,
"offset": 557
}
}
},
"tags": [
{
"title": "desc",
"description": "Sends a message to the {@link /docs/rockyjs/ Rocky.js} component. Please be aware \n that messages should be kept concise. Each message is queued, so \n `postMessage()` can be called multiple times immediately. If there is a momentary loss of connectivity, queued \n messages may still be delivered, or automatically removed from the queue \n after a few seconds of failed connectivity. Any transmission failures, or \n out of memory errors will be raised via the `postmessageerror` event.\n\n`Pebble.postMessage({temperature: 30, conditions: 'Sunny'});`",
"lineNumber": 1
},
{
"title": "param",
"description": "A {@link #PostMessageCallback PostMessageCallback} containing \n the data to deliver to the watch.\n This will be received in the `data` field of the `type` delivered to \n the `on('message', ...)` handler.",
"lineNumber": 10,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "data"
}
],
"loc": {
"start": {
"line": 128,
"column": 0
},
"end": {
"line": 142,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 143,
"column": 0
},
"end": {
"line": 143,
"column": 40
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "data",
"lineNumber": 10,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 3,
"offset": 2
},
"indent": []
}
},
{
"type": "link",
"url": "#PostMessageCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "PostMessageCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 3,
"offset": 2
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
},
{
"type": "text",
"value": " containing \n the data to deliver to the watch.\n This will be received in the ",
"position": {
"start": {
"line": 1,
"column": 51,
"offset": 50
},
"end": {
"line": 3,
"column": 38,
"offset": 142
},
"indent": [
1,
1
]
}
},
{
"type": "inlineCode",
"value": "data",
"position": {
"start": {
"line": 3,
"column": 38,
"offset": 142
},
"end": {
"line": 3,
"column": 44,
"offset": 148
},
"indent": []
}
},
{
"type": "text",
"value": " field of the ",
"position": {
"start": {
"line": 3,
"column": 44,
"offset": 148
},
"end": {
"line": 3,
"column": 58,
"offset": 162
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 3,
"column": 58,
"offset": 162
},
"end": {
"line": 3,
"column": 64,
"offset": 168
},
"indent": []
}
},
{
"type": "text",
"value": " delivered to \n the ",
"position": {
"start": {
"line": 3,
"column": 64,
"offset": 168
},
"end": {
"line": 4,
"column": 13,
"offset": 195
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "on('message', ...)",
"position": {
"start": {
"line": 4,
"column": 13,
"offset": 195
},
"end": {
"line": 4,
"column": 33,
"offset": 215
},
"indent": []
}
},
{
"type": "text",
"value": " handler.",
"position": {
"start": {
"line": 4,
"column": 33,
"offset": 215
},
"end": {
"line": 4,
"column": 42,
"offset": 224
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 42,
"offset": 224
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 42,
"offset": 224
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"name": "postMessage",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "postMessage",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.postMessage"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Get the user's timeline token for this app. This is a string and is \n unique per user per app. Note: In order for timeline tokens to be \n available, the app must be submitted to the Pebble appstore, but does not \n need to be public. Read more in the \n ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 5,
"offset": 264
},
"indent": [
1,
1,
1,
1
]
}
},
{
"type": "link",
"url": "/guides/pebble-timeline/timeline-js/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "timeline guides"
}
],
"position": {
"start": {
"line": 5,
"column": 5,
"offset": 264
},
"end": {
"line": 5,
"column": 65,
"offset": 324
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 5,
"column": 65,
"offset": 324
},
"end": {
"line": 5,
"column": 66,
"offset": 325
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 66,
"offset": 325
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 66,
"offset": 325
}
}
},
"tags": [
{
"title": "desc",
"description": "Get the user's timeline token for this app. This is a string and is \n unique per user per app. Note: In order for timeline tokens to be \n available, the app must be submitted to the Pebble appstore, but does not \n need to be public. Read more in the \n {@link /guides/pebble-timeline/timeline-js/ timeline guides}.",
"lineNumber": 1
},
{
"title": "param",
"description": "A developer-defined {@link #TimelineTokenCallback TimelineTokenCallback} \n callback to handle a successful attempt to get the timeline token.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "TimelineTokenCallback"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "A developer-defined callback to handle a \n failed attempt to get the timeline token.",
"lineNumber": 9,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 145,
"column": 0
},
"end": {
"line": 156,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 157,
"column": 1
},
"end": {
"line": 157,
"column": 62
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "onSuccess",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 21,
"offset": 20
},
"indent": []
}
},
{
"type": "link",
"url": "#TimelineTokenCallback",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "TimelineTokenCallback"
}
],
"position": {
"start": {
"line": 1,
"column": 21,
"offset": 20
},
"end": {
"line": 1,
"column": 73,
"offset": 72
},
"indent": []
}
},
{
"type": "text",
"value": " \n callback to handle a successful attempt to get the timeline token.",
"position": {
"start": {
"line": 1,
"column": 73,
"offset": 72
},
"end": {
"line": 2,
"column": 71,
"offset": 144
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 71,
"offset": 144
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 71,
"offset": 144
}
}
},
"type": {
"type": "NameExpression",
"name": "TimelineTokenCallback"
}
},
{
"name": "onFailure",
"lineNumber": 9,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined callback to handle a \n failed attempt to get the timeline token.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 46,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 46,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 46,
"offset": 87
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "getTimelineToken",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "getTimelineToken",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.getTimelineToken"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Subscribe the user to a timeline topic for your app. This can be used \n to filter the different pins a user could receive according to their \n preferences, as well as maintain groups of users.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 54,
"offset": 198
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 54,
"offset": 198
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 54,
"offset": 198
}
}
},
"tags": [
{
"title": "desc",
"description": "Subscribe the user to a timeline topic for your app. This can be used \n to filter the different pins a user could receive according to their \n preferences, as well as maintain groups of users.",
"lineNumber": 1
},
{
"title": "param",
"description": "The desired topic to be subscribed to. Users will \n receive all pins pushed to this topic.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "topic"
},
{
"title": "param",
"description": "A developer-defined callback to handle a \n successful subscription attempt.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "A developer-defined callback to handle a \n failed subscription attempt.",
"lineNumber": 9,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 159,
"column": 0
},
"end": {
"line": 170,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 171,
"column": 0
},
"end": {
"line": 171,
"column": 69
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "topic",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The desired topic to be subscribed to. Users will \n receive all pins pushed to this topic.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 93
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 93
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 93
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "onSuccess",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined callback to handle a \n successful subscription attempt.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 37,
"offset": 78
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 37,
"offset": 78
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 37,
"offset": 78
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
},
{
"name": "onFailure",
"lineNumber": 9,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined callback to handle a \n failed subscription attempt.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 33,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 33,
"offset": 74
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 33,
"offset": 74
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "timelineSubscribe",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "timelineSubscribe",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.timelineSubscribe"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Unsubscribe the user from a timeline topic for your app. Once \n unsubscribed, the user will no longer receive any pins pushed to this \n topic.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 11,
"offset": 148
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 11,
"offset": 148
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 11,
"offset": 148
}
}
},
"tags": [
{
"title": "desc",
"description": "Unsubscribe the user from a timeline topic for your app. Once \n unsubscribed, the user will no longer receive any pins pushed to this \n topic.",
"lineNumber": 1
},
{
"title": "param",
"description": "The desired topic to be unsubscribed from.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "topic"
},
{
"title": "param",
"description": "A developer-defined callback to handle a \n successful unsubscription attempt.",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "A developer-defined callback to handle a \n failed unsubscription attempt.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 173,
"column": 0
},
"end": {
"line": 183,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 184,
"column": 0
},
"end": {
"line": 184,
"column": 71
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "topic",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The desired topic to be unsubscribed from.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "onSuccess",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined callback to handle a \n successful unsubscription attempt.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 39,
"offset": 80
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 39,
"offset": 80
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 39,
"offset": 80
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
},
{
"name": "onFailure",
"lineNumber": 8,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A developer-defined callback to handle a \n failed unsubscription attempt.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 76
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 76
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 76
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "timelineUnsubscribe",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "timelineUnsubscribe",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.timelineUnsubscribe"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Obtain a list of topics that the user is currently subscribed to. The \n length of the list should be checked to determine whether the user is \n subscribed to at least one topic.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 38,
"offset": 183
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 38,
"offset": 183
},
"indent": [
1,
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": " ",
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 185
},
"end": {
"line": 5,
"column": 4,
"offset": 188
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "Pebble.timelineSubscriptions(function(topics) { console.log(topics); }, function() { console.log('error'); } );",
"position": {
"start": {
"line": 5,
"column": 4,
"offset": 188
},
"end": {
"line": 5,
"column": 117,
"offset": 301
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 185
},
"end": {
"line": 5,
"column": 117,
"offset": 301
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 117,
"offset": 301
}
}
},
"tags": [
{
"title": "desc",
"description": "Obtain a list of topics that the user is currently subscribed to. The \n length of the list should be checked to determine whether the user is \n subscribed to at least one topic.\n\n `Pebble.timelineSubscriptions(function(topics) { console.log(topics); }, function() { console.log('error'); } );`",
"lineNumber": 1
},
{
"title": "param",
"description": "The developer-defined function to process the \n retuned list of topic strings.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "TimelineTopicsCallback"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "The developer-defined function to gracefully \n handle any errors in obtaining the user's subscriptions.",
"lineNumber": 9,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 186,
"column": 0
},
"end": {
"line": 197,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 198,
"column": 0
},
"end": {
"line": 198,
"column": 66
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "onSuccess",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer-defined function to process the \n retuned list of topic strings.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 81
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 81
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 35,
"offset": 81
}
}
},
"type": {
"type": "NameExpression",
"name": "TimelineTopicsCallback"
}
},
{
"name": "onFailure",
"lineNumber": 9,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer-defined function to gracefully \n handle any errors in obtaining the user's subscriptions.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 61,
"offset": 106
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 61,
"offset": 106
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 61,
"offset": 106
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
}
],
"name": "timelineSubscriptions",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "timelineSubscriptions",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.timelineSubscriptions"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Obtain an object containing information on the currently connected \n Pebble smartwatch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 23,
"offset": 90
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 23,
"offset": 90
},
"indent": [
1
]
}
},
{
"type": "code",
"lang": null,
"value": "**Note:** This function is only available when using the Pebble Time \nsmartphone app. Check out our guide on {@link /guides/communication/using-pebblekit-js Getting Watch Information} \nfor details on how to use this function.",
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 92
},
"end": {
"line": 6,
"column": 45,
"offset": 329
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 45,
"offset": 329
}
}
},
"tags": [
{
"title": "desc",
"description": "Obtain an object containing information on the currently connected \n Pebble smartwatch.\n\n **Note:** This function is only available when using the Pebble Time \n smartphone app. Check out our guide on {@link /guides/communication/using-pebblekit-js Getting Watch Information} \n for details on how to use this function.",
"lineNumber": 1
},
{
"title": "returns",
"description": "A {@link #WatchInfo WatchInfo} object detailing the \n currently connected Pebble watch.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "WatchInfo"
}
}
],
"loc": {
"start": {
"line": 201,
"column": 0
},
"end": {
"line": 211,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 212,
"column": 0
},
"end": {
"line": 212,
"column": 43
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 3,
"offset": 2
},
"indent": []
}
},
{
"type": "link",
"url": "#WatchInfo",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "WatchInfo"
}
],
"position": {
"start": {
"line": 1,
"column": 3,
"offset": 2
},
"end": {
"line": 1,
"column": 31,
"offset": 30
},
"indent": []
}
},
{
"type": "text",
"value": " object detailing the \n currently connected Pebble watch.",
"position": {
"start": {
"line": 1,
"column": 31,
"offset": 30
},
"end": {
"line": 2,
"column": 38,
"offset": 90
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 90
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 90
}
}
},
"type": {
"type": "NameExpression",
"name": "WatchInfo"
}
}
],
"name": "getActiveWatchInfo",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "getActiveWatchInfo",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.getActiveWatchInfo"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Returns a unique account token that is associated with the Pebble \n account of the current user.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 33,
"offset": 99
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 33,
"offset": 99
},
"indent": [
1
]
}
},
{
"type": "code",
"lang": null,
"value": "**Note:** The behavior of this changed slightly in SDK 3.0. Read the \n{@link /guides/migration/migration-guide-3/ Migration Guide} to learn the \ndetails and how to adapt older tokens.",
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 101
},
"end": {
"line": 6,
"column": 43,
"offset": 296
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 43,
"offset": 296
}
}
},
"tags": [
{
"title": "desc",
"description": "Returns a unique account token that is associated with the Pebble \n account of the current user.\n\n **Note:** The behavior of this changed slightly in SDK 3.0. Read the \n {@link /guides/migration/migration-guide-3/ Migration Guide} to learn the \n details and how to adapt older tokens.",
"lineNumber": 1
},
{
"title": "returns",
"description": "A string that is guaranteed to be identical across devices \n if the user owns several Pebble or several mobile devices. From the \n developer's perspective, the account token of a user is identical across \n platforms and across all the developer's watchapps. If the user is not \n logged in, this function will return an empty string ('').",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"loc": {
"start": {
"line": 214,
"column": 0
},
"end": {
"line": 227,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 229,
"column": 0
},
"end": {
"line": 229,
"column": 40
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A string that is guaranteed to be identical across devices \n if the user owns several Pebble or several mobile devices. From the \n developer's perspective, the account token of a user is identical across \n platforms and across all the developer's watchapps. If the user is not \n logged in, this function will return an empty string ('').",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 63,
"offset": 349
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 63,
"offset": 349
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 63,
"offset": 349
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"name": "getAccountToken",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "getAccountToken",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.getAccountToken"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Returns a a unique token that can be used to identify a Pebble device.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 71,
"offset": 70
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 71,
"offset": 70
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 71,
"offset": 70
}
}
},
"tags": [
{
"title": "desc",
"description": "Returns a a unique token that can be used to identify a Pebble device.",
"lineNumber": 1
},
{
"title": "returns",
"description": "A string that is is guaranteed to be identical for each \n Pebble device for the same app across different mobile devices. The token \n is unique to your app and cannot be used to track Pebble devices across \n applications.",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"loc": {
"start": {
"line": 231,
"column": 0
},
"end": {
"line": 238,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 239,
"column": 0
},
"end": {
"line": 239,
"column": 38
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A string that is is guaranteed to be identical for each \n Pebble device for the same app across different mobile devices. The token \n is unique to your app and cannot be used to track Pebble devices across \n applications.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 18,
"offset": 230
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 18,
"offset": 230
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 18,
"offset": 230
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"name": "getWatchToken",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "getWatchToken",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.getWatchToken"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Triggers a reload of the app glance which first clears any existing \n slices and then adds the provided slices.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 111
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 111
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 111
}
}
},
"tags": [
{
"title": "desc",
"description": "Triggers a reload of the app glance which first clears any existing \n slices and then adds the provided slices.",
"lineNumber": 1
},
{
"title": "param",
"description": "{@link #AppGlanceSlice AppGlanceSlice} \n JSON objects to add to the app glance.",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
},
"name": "appGlanceSlices"
},
{
"title": "param",
"description": "The developer-defined \n callback which is called if the reload operation succeeds.",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "AppGlanceReloadSuccessCallback"
},
"name": "onSuccess"
},
{
"title": "param",
"description": "The developer-defined \n callback which is called if the reload operation fails.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "AppGlanceReloadFailureCallback"
},
"name": "onFailure"
}
],
"loc": {
"start": {
"line": 242,
"column": 0
},
"end": {
"line": 252,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 253,
"column": 0
},
"end": {
"line": 253,
"column": 77
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "appGlanceSlices",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"url": "#AppGlanceSlice",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "AppGlanceSlice"
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
},
{
"type": "text",
"value": " \n JSON objects to add to the app glance.",
"position": {
"start": {
"line": 1,
"column": 39,
"offset": 38
},
"end": {
"line": 2,
"column": 43,
"offset": 82
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 82
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 43,
"offset": 82
}
}
},
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
}
},
{
"name": "onSuccess",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer-defined \n callback which is called if the reload operation succeeds.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 63,
"offset": 85
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 63,
"offset": 85
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 63,
"offset": 85
}
}
},
"type": {
"type": "NameExpression",
"name": "AppGlanceReloadSuccessCallback"
}
},
{
"name": "onFailure",
"lineNumber": 8,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The developer-defined \n callback which is called if the reload operation fails.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 60,
"offset": 82
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 60,
"offset": 82
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 60,
"offset": 82
}
}
},
"type": {
"type": "NameExpression",
"name": "AppGlanceReloadFailureCallback"
}
}
],
"name": "appGlanceReload",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "appGlanceReload",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.appGlanceReload"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when the user's list of subscriptions is available for processing by the developer.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 91,
"offset": 90
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 91,
"offset": 90
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 91,
"offset": 90
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "TimelineTopicsCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when the user's list of subscriptions is available for processing by the developer.",
"lineNumber": 4
},
{
"title": "param",
"description": "of topic strings that the user is subscribed to",
"lineNumber": 5,
"type": {
"type": "ArrayType",
"elements": [
{
"type": "NameExpression",
"name": "String"
}
]
},
"name": "List"
}
],
"loc": {
"start": {
"line": 328,
"column": 0
},
"end": {
"line": 334,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "TimelineTopicsCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "List",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "of topic strings that the user is subscribed to",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 48,
"offset": 47
}
}
},
"type": {
"type": "ArrayType",
"elements": [
{
"type": "NameExpression",
"name": "String"
}
]
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "TimelineTopicsCallback",
"kind": "typedef"
}
],
"namespace": "PebbleTimelineTopicsCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "When an app is marked as configurable, the PebbleKit JS component must \n implement ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 12,
"offset": 83
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "Pebble.openURL()",
"position": {
"start": {
"line": 2,
"column": 12,
"offset": 83
},
"end": {
"line": 2,
"column": 30,
"offset": 101
},
"indent": []
}
},
{
"type": "text",
"value": " in the ",
"position": {
"start": {
"line": 2,
"column": 30,
"offset": 101
},
"end": {
"line": 2,
"column": 38,
"offset": 109
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "showConfiguration",
"position": {
"start": {
"line": 2,
"column": 38,
"offset": 109
},
"end": {
"line": 2,
"column": 57,
"offset": 128
},
"indent": []
}
},
{
"type": "text",
"value": " event handler. The \n Pebble mobile app will launch the supplied URL to allow the user to configure \n the watchapp or watchface. See the \n ",
"position": {
"start": {
"line": 2,
"column": 57,
"offset": 128
},
"end": {
"line": 5,
"column": 2,
"offset": 267
},
"indent": [
1,
1,
1
]
}
},
{
"type": "link",
"url": "/guides/user-interfaces/app-configuration-static/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "App Configuration guide"
}
],
"position": {
"start": {
"line": 5,
"column": 2,
"offset": 267
},
"end": {
"line": 5,
"column": 83,
"offset": 348
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 5,
"column": 83,
"offset": 348
},
"end": {
"line": 5,
"column": 84,
"offset": 349
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 84,
"offset": 349
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 5,
"column": 84,
"offset": 349
}
}
},
"tags": [
{
"title": "desc",
"description": "When an app is marked as configurable, the PebbleKit JS component must \n implement `Pebble.openURL()` in the `showConfiguration` event handler. The \n Pebble mobile app will launch the supplied URL to allow the user to configure \n the watchapp or watchface. See the \n {@link /guides/user-interfaces/app-configuration-static/ App Configuration guide}.",
"lineNumber": 1
},
{
"title": "param",
"description": "The URL of the static configuration page.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "url"
}
],
"loc": {
"start": {
"line": 255,
"column": 0
},
"end": {
"line": 263,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"params": [
{
"name": "url",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The URL of the static configuration page.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"name": "openURL",
"kind": "function",
"memberof": "Pebble",
"scope": "static",
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "openURL",
"kind": "function",
"scope": "static"
}
],
"namespace": "Pebble.openURL"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when AppGlanceReload has failed.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "AppGlanceReloadFailureCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when AppGlanceReload has failed.",
"lineNumber": 4
},
{
"title": "param",
"description": "An {@link #AppGlanceSlice AppGlanceSlice} object \n containing the app glance slices.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
},
"name": "AppGlanceSlices"
}
],
"loc": {
"start": {
"line": 275,
"column": 1
},
"end": {
"line": 282,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "AppGlanceReloadFailureCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "AppGlanceSlices",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 4,
"offset": 3
},
"indent": []
}
},
{
"type": "link",
"url": "#AppGlanceSlice",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "AppGlanceSlice"
}
],
"position": {
"start": {
"line": 1,
"column": 4,
"offset": 3
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
},
{
"type": "text",
"value": " object \n containing the app glance slices.",
"position": {
"start": {
"line": 1,
"column": 42,
"offset": 41
},
"end": {
"line": 2,
"column": 38,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 87
}
}
},
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "AppGlanceReloadFailureCallback",
"kind": "typedef"
}
],
"namespace": "PebbleAppGlanceReloadFailureCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when an AppMessage is acknowledged by the watch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "AppMessageAckCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when an AppMessage is acknowledged by the watch.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing the callback data. This contains \n the `transactionId` which is the transaction ID of the message.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "data"
}
],
"loc": {
"start": {
"line": 284,
"column": 0
},
"end": {
"line": 291,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "AppMessageAckCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "data",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing the callback data. This contains \n the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 7,
"offset": 61
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "transactionId",
"position": {
"start": {
"line": 2,
"column": 7,
"offset": 61
},
"end": {
"line": 2,
"column": 22,
"offset": 76
},
"indent": []
}
},
{
"type": "text",
"value": " which is the transaction ID of the message.",
"position": {
"start": {
"line": 2,
"column": 22,
"offset": 76
},
"end": {
"line": 2,
"column": 66,
"offset": 120
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 120
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 120
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "AppMessageAckCallback",
"kind": "typedef"
}
],
"namespace": "PebbleAppMessageAckCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when an AppMessage is not acknowledged by the watch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "AppMessageNackCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when an AppMessage is not acknowledged by the watch.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing the callback data. This contains \n the `transactionId` which is the transaction ID of the message",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "data"
},
{
"title": "param",
"description": "The error message",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "error"
}
],
"loc": {
"start": {
"line": 293,
"column": 0
},
"end": {
"line": 301,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "AppMessageNackCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "data",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing the callback data. This contains \n the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 7,
"offset": 61
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "transactionId",
"position": {
"start": {
"line": 2,
"column": 7,
"offset": 61
},
"end": {
"line": 2,
"column": 22,
"offset": 76
},
"indent": []
}
},
{
"type": "text",
"value": " which is the transaction ID of the message",
"position": {
"start": {
"line": 2,
"column": 22,
"offset": 76
},
"end": {
"line": 2,
"column": 65,
"offset": 119
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 65,
"offset": 119
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 65,
"offset": 119
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
},
{
"name": "error",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The error message",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "AppMessageNackCallback",
"kind": "typedef"
}
],
"namespace": "PebbleAppMessageNackCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when an event of any type previously registered occurs. The \n parameters are different depending on the type of event, shown in \n brackets for each parameter listed here.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 45,
"offset": 183
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 45,
"offset": 183
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 45,
"offset": 183
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "EventCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when an event of any type previously registered occurs. The \n parameters are different depending on the type of event, shown in \n brackets for each parameter listed here.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing the event information, including:\n * `type` - The type of event fired, from the list in the description of [Pebble.addEventListener()](#addEventListener).\n * `payload` - The dictionary sent over ``AppMessage`` consisting of \n key-value pairs. *This field only exists for `appmessage` events.*\n * `response` - The contents of the URL navigated to when the \n configuration page was closed, after the anchor. This may be encoded, \n which will require use of decodeURIComponent() before reading as an \n object. *This field only exists for for `webviewclosed` events.*",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "event"
}
],
"loc": {
"start": {
"line": 303,
"column": 0
},
"end": {
"line": 318,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "EventCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "event",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing the event information, including:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 2,
"column": 6,
"offset": 60
},
"end": {
"line": 2,
"column": 12,
"offset": 66
},
"indent": []
}
},
{
"type": "text",
"value": " - The type of event fired, from the list in the description of ",
"position": {
"start": {
"line": 2,
"column": 12,
"offset": 66
},
"end": {
"line": 2,
"column": 76,
"offset": 130
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "#addEventListener",
"children": [
{
"type": "text",
"value": "Pebble.addEventListener()",
"position": {
"start": {
"line": 2,
"column": 77,
"offset": 131
},
"end": {
"line": 2,
"column": 102,
"offset": 156
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 76,
"offset": 130
},
"end": {
"line": 2,
"column": 122,
"offset": 176
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 122,
"offset": 176
},
"end": {
"line": 2,
"column": 123,
"offset": 177
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 6,
"offset": 60
},
"end": {
"line": 2,
"column": 123,
"offset": 177
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 55
},
"end": {
"line": 2,
"column": 123,
"offset": 177
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "payload",
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 183
},
"end": {
"line": 3,
"column": 15,
"offset": 192
},
"indent": []
}
},
{
"type": "text",
"value": " - The dictionary sent over ",
"position": {
"start": {
"line": 3,
"column": 15,
"offset": 192
},
"end": {
"line": 3,
"column": 43,
"offset": 220
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "AppMessage",
"position": {
"start": {
"line": 3,
"column": 43,
"offset": 220
},
"end": {
"line": 3,
"column": 57,
"offset": 234
},
"indent": []
}
},
{
"type": "text",
"value": " consisting of \nkey-value pairs. ",
"position": {
"start": {
"line": 3,
"column": 57,
"offset": 234
},
"end": {
"line": 4,
"column": 23,
"offset": 272
},
"indent": [
6
]
}
},
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "This field only exists for ",
"position": {
"start": {
"line": 4,
"column": 24,
"offset": 273
},
"end": {
"line": 4,
"column": 51,
"offset": 300
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "appmessage",
"position": {
"start": {
"line": 4,
"column": 51,
"offset": 300
},
"end": {
"line": 4,
"column": 63,
"offset": 312
},
"indent": []
}
},
{
"type": "text",
"value": " events.",
"position": {
"start": {
"line": 4,
"column": 63,
"offset": 312
},
"end": {
"line": 4,
"column": 71,
"offset": 320
},
"indent": []
}
}
],
"position": {
"start": {
"line": 4,
"column": 23,
"offset": 272
},
"end": {
"line": 4,
"column": 72,
"offset": 321
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 183
},
"end": {
"line": 4,
"column": 72,
"offset": 321
},
"indent": [
6
]
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 178
},
"end": {
"line": 4,
"column": 72,
"offset": 321
},
"indent": [
1
]
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "response",
"position": {
"start": {
"line": 5,
"column": 6,
"offset": 327
},
"end": {
"line": 5,
"column": 16,
"offset": 337
},
"indent": []
}
},
{
"type": "text",
"value": " - The contents of the URL navigated to when the \nconfiguration page was closed, after the anchor. This may be encoded, \nwhich will require use of decodeURIComponent() before reading as an \nobject. ",
"position": {
"start": {
"line": 5,
"column": 16,
"offset": 337
},
"end": {
"line": 8,
"column": 14,
"offset": 550
},
"indent": [
6,
6,
6
]
}
},
{
"type": "emphasis",
"children": [
{
"type": "text",
"value": "This field only exists for for ",
"position": {
"start": {
"line": 8,
"column": 15,
"offset": 551
},
"end": {
"line": 8,
"column": 46,
"offset": 582
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "webviewclosed",
"position": {
"start": {
"line": 8,
"column": 46,
"offset": 582
},
"end": {
"line": 8,
"column": 61,
"offset": 597
},
"indent": []
}
},
{
"type": "text",
"value": " events.",
"position": {
"start": {
"line": 8,
"column": 61,
"offset": 597
},
"end": {
"line": 8,
"column": 69,
"offset": 605
},
"indent": []
}
}
],
"position": {
"start": {
"line": 8,
"column": 14,
"offset": 550
},
"end": {
"line": 8,
"column": 70,
"offset": 606
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 6,
"offset": 327
},
"end": {
"line": 8,
"column": 70,
"offset": 606
},
"indent": [
6,
6,
6
]
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 322
},
"end": {
"line": 8,
"column": 70,
"offset": 606
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 55
},
"end": {
"line": 8,
"column": 70,
"offset": 606
},
"indent": [
1,
1,
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 8,
"column": 70,
"offset": 606
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "EventCallback",
"kind": "typedef"
}
],
"namespace": "PebbleEventCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when the user's timeline token is available.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "TimelineTokenCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when the user's timeline token is available.",
"lineNumber": 4
},
{
"title": "param",
"description": "The user's token.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "token"
}
],
"loc": {
"start": {
"line": 320,
"column": 0
},
"end": {
"line": 326,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "TimelineTokenCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "token",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The user's token.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "TimelineTokenCallback",
"kind": "typedef"
}
],
"namespace": "PebbleTimelineTokenCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Called when AppGlanceReload is successful.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 43,
"offset": 42
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "AppGlanceReloadSuccessCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Called when AppGlanceReload is successful.",
"lineNumber": 4
},
{
"title": "param",
"description": "An {@link #AppGlanceSlice AppGlanceSlice} object \n containing the app glance slices.",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
},
"name": "AppGlanceSlices"
}
],
"loc": {
"start": {
"line": 266,
"column": 0
},
"end": {
"line": 273,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "AppGlanceReloadSuccessCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "AppGlanceSlices",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 4,
"offset": 3
},
"indent": []
}
},
{
"type": "link",
"url": "#AppGlanceSlice",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "AppGlanceSlice"
}
],
"position": {
"start": {
"line": 1,
"column": 4,
"offset": 3
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
},
{
"type": "text",
"value": " object \n containing the app glance slices.",
"position": {
"start": {
"line": 1,
"column": 42,
"offset": 41
},
"end": {
"line": 2,
"column": 38,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 87
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 38,
"offset": 87
}
}
},
"type": {
"type": "NameExpression",
"name": "AppGlanceSlice"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "AppGlanceReloadSuccessCallback",
"kind": "typedef"
}
],
"namespace": "PebbleAppGlanceReloadSuccessCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The callback function signature to be used with the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 53,
"offset": 52
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "message",
"position": {
"start": {
"line": 1,
"column": 53,
"offset": 52
},
"end": {
"line": 1,
"column": 62,
"offset": 61
},
"indent": []
}
},
{
"type": "text",
"value": "\n ",
"position": {
"start": {
"line": 1,
"column": 62,
"offset": 61
},
"end": {
"line": 2,
"column": 4,
"offset": 65
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "#on",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "event"
}
],
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 65
},
"end": {
"line": 2,
"column": 21,
"offset": 82
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 21,
"offset": 82
},
"end": {
"line": 2,
"column": 22,
"offset": 83
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 83
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 83
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "PostMessageCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "The callback function signature to be used with the `message`\n {@link #on event}.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing information about the event:\n * `type` - The type of event which was triggered.\n * `data` - The data sent within the message.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "event"
}
],
"loc": {
"start": {
"line": 336,
"column": 0
},
"end": {
"line": 346,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "PostMessageCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "event",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing information about the event:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 11,
"offset": 60
},
"indent": []
}
},
{
"type": "text",
"value": " - The type of event which was triggered.",
"position": {
"start": {
"line": 2,
"column": 11,
"offset": 60
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "data",
"position": {
"start": {
"line": 3,
"column": 5,
"offset": 106
},
"end": {
"line": 3,
"column": 11,
"offset": 112
},
"indent": []
}
},
{
"type": "text",
"value": " - The data sent within the message.",
"position": {
"start": {
"line": 3,
"column": 11,
"offset": 112
},
"end": {
"line": 3,
"column": 47,
"offset": 148
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 5,
"offset": 106
},
"end": {
"line": 3,
"column": 47,
"offset": 148
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 102
},
"end": {
"line": 3,
"column": 47,
"offset": 148
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 3,
"column": 47,
"offset": 148
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 47,
"offset": 148
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "PostMessageCallback",
"kind": "typedef"
}
],
"namespace": "PebblePostMessageCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The callback function signature to be used with the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 53,
"offset": 52
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "postmessageerror",
"position": {
"start": {
"line": 1,
"column": 53,
"offset": 52
},
"end": {
"line": 1,
"column": 71,
"offset": 70
},
"indent": []
}
},
{
"type": "text",
"value": "\n ",
"position": {
"start": {
"line": 1,
"column": 71,
"offset": 70
},
"end": {
"line": 2,
"column": 4,
"offset": 74
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "#on",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "event"
}
],
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 74
},
"end": {
"line": 2,
"column": 21,
"offset": 91
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 21,
"offset": 91
},
"end": {
"line": 2,
"column": 22,
"offset": 92
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 92
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 92
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "PostMessageErrorCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "The callback function signature to be used with the `postmessageerror`\n {@link #on event}.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing information about the event:\n * `type` - The type of event which was triggered.\n * `data` - The data failed to send within the message.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "event"
}
],
"loc": {
"start": {
"line": 348,
"column": 0
},
"end": {
"line": 358,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "PostMessageErrorCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "event",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing information about the event:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 11,
"offset": 60
},
"indent": []
}
},
{
"type": "text",
"value": " - The type of event which was triggered.",
"position": {
"start": {
"line": 2,
"column": 11,
"offset": 60
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "data",
"position": {
"start": {
"line": 3,
"column": 5,
"offset": 106
},
"end": {
"line": 3,
"column": 11,
"offset": 112
},
"indent": []
}
},
{
"type": "text",
"value": " - The data failed to send within the message.",
"position": {
"start": {
"line": 3,
"column": 11,
"offset": 112
},
"end": {
"line": 3,
"column": 57,
"offset": 158
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 5,
"offset": 106
},
"end": {
"line": 3,
"column": 57,
"offset": 158
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 102
},
"end": {
"line": 3,
"column": 57,
"offset": 158
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 3,
"column": 57,
"offset": 158
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 57,
"offset": 158
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "PostMessageErrorCallback",
"kind": "typedef"
}
],
"namespace": "PebblePostMessageErrorCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The callback function signature to be used with the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 53,
"offset": 52
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "postmessageconnected",
"position": {
"start": {
"line": 1,
"column": 53,
"offset": 52
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
},
{
"type": "text",
"value": "\n ",
"position": {
"start": {
"line": 1,
"column": 75,
"offset": 74
},
"end": {
"line": 2,
"column": 4,
"offset": 78
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "#on",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "event"
}
],
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 78
},
"end": {
"line": 2,
"column": 21,
"offset": 95
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 21,
"offset": 95
},
"end": {
"line": 2,
"column": 22,
"offset": 96
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 96
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 96
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "PostMessageConnectedCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "The callback function signature to be used with the `postmessageconnected`\n {@link #on event}.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing information about the event:\n * `type` - The type of event which was triggered.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "event"
}
],
"loc": {
"start": {
"line": 360,
"column": 0
},
"end": {
"line": 369,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "PostMessageConnectedCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "event",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing information about the event:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 11,
"offset": 60
},
"indent": []
}
},
{
"type": "text",
"value": " - The type of event which was triggered.",
"position": {
"start": {
"line": 2,
"column": 11,
"offset": 60
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 52,
"offset": 101
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "PostMessageConnectedCallback",
"kind": "typedef"
}
],
"namespace": "PebblePostMessageConnectedCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The callback function signature to be used with the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 53,
"offset": 52
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "postmessagedisconnected",
"position": {
"start": {
"line": 1,
"column": 53,
"offset": 52
},
"end": {
"line": 1,
"column": 78,
"offset": 77
},
"indent": []
}
},
{
"type": "text",
"value": "\n ",
"position": {
"start": {
"line": 1,
"column": 78,
"offset": 77
},
"end": {
"line": 2,
"column": 4,
"offset": 81
},
"indent": [
1
]
}
},
{
"type": "link",
"url": "#on",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "event"
}
],
"position": {
"start": {
"line": 2,
"column": 4,
"offset": 81
},
"end": {
"line": 2,
"column": 21,
"offset": 98
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 2,
"column": 21,
"offset": 98
},
"end": {
"line": 2,
"column": 22,
"offset": 99
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 99
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 22,
"offset": 99
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "PostMessageDisconnectedCallback"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "The callback function signature to be used with the `postmessagedisconnected`\n {@link #on event}.",
"lineNumber": 4
},
{
"title": "param",
"description": "An object containing information about the event:\n * `type` - The type of event which was triggered.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "event"
}
],
"loc": {
"start": {
"line": 371,
"column": 0
},
"end": {
"line": 380,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "PostMessageDisconnectedCallback",
"type": {
"type": "NameExpression",
"name": "Function"
},
"memberof": "Pebble",
"params": [
{
"name": "event",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing information about the event:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "type",
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 11,
"offset": 60
},
"indent": []
}
},
{
"type": "text",
"value": " - The type of event which was triggered.",
"position": {
"start": {
"line": 2,
"column": 11,
"offset": 60
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 5,
"offset": 54
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 50
},
"end": {
"line": 2,
"column": 52,
"offset": 101
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 52,
"offset": 101
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "PostMessageDisconnectedCallback",
"kind": "typedef"
}
],
"namespace": "PebblePostMessageDisconnectedCallback"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Provides information about the connected Pebble smartwatch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 60,
"offset": 59
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "WatchInfo"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "Provides information about the connected Pebble smartwatch.",
"lineNumber": 4
},
{
"title": "property",
"description": "The hardware platform, such as `basalt` or `emery`.",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "platform"
},
{
"title": "property",
"description": "The watch model, such as `pebble_black`",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "model"
},
{
"title": "property",
"description": "The user's currently selected language on\n this watch.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "language"
},
{
"title": "property",
"description": "An object containing information about the\n watch's firmware version, including:\n * `major` - The major version\n * `minor` - The minor version\n * `patch` - The patch version\n * `suffix` - Any additional version information, such as `beta3`",
"lineNumber": 10,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "firmware"
}
],
"loc": {
"start": {
"line": 383,
"column": 0
},
"end": {
"line": 399,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "WatchInfo",
"type": {
"type": "NameExpression",
"name": "Object"
},
"memberof": "Pebble",
"properties": [
{
"name": "platform",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The hardware platform, such as ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "basalt",
"position": {
"start": {
"line": 1,
"column": 32,
"offset": 31
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
},
{
"type": "text",
"value": " or ",
"position": {
"start": {
"line": 1,
"column": 40,
"offset": 39
},
"end": {
"line": 1,
"column": 44,
"offset": 43
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "emery",
"position": {
"start": {
"line": 1,
"column": 44,
"offset": 43
},
"end": {
"line": 1,
"column": 51,
"offset": 50
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 1,
"column": 51,
"offset": 50
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 52,
"offset": 51
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "model",
"lineNumber": 7,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The watch model, such as ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 26,
"offset": 25
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "pebble_black",
"position": {
"start": {
"line": 1,
"column": 26,
"offset": 25
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "language",
"lineNumber": 8,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The user's currently selected language on\n this watch.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 16,
"offset": 57
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 16,
"offset": 57
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 16,
"offset": 57
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "firmware",
"lineNumber": 10,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing information about the\n watch's firmware version, including:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 41,
"offset": 83
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 41,
"offset": 83
},
"indent": [
1
]
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "major",
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 89
},
"end": {
"line": 3,
"column": 13,
"offset": 96
},
"indent": []
}
},
{
"type": "text",
"value": " - The major version",
"position": {
"start": {
"line": 3,
"column": 13,
"offset": 96
},
"end": {
"line": 3,
"column": 33,
"offset": 116
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 89
},
"end": {
"line": 3,
"column": 33,
"offset": 116
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 84
},
"end": {
"line": 3,
"column": 33,
"offset": 116
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "minor",
"position": {
"start": {
"line": 4,
"column": 6,
"offset": 122
},
"end": {
"line": 4,
"column": 13,
"offset": 129
},
"indent": []
}
},
{
"type": "text",
"value": " - The minor version",
"position": {
"start": {
"line": 4,
"column": 13,
"offset": 129
},
"end": {
"line": 4,
"column": 33,
"offset": 149
},
"indent": []
}
}
],
"position": {
"start": {
"line": 4,
"column": 6,
"offset": 122
},
"end": {
"line": 4,
"column": 33,
"offset": 149
},
"indent": []
}
}
],
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 117
},
"end": {
"line": 4,
"column": 33,
"offset": 149
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "patch",
"position": {
"start": {
"line": 5,
"column": 6,
"offset": 155
},
"end": {
"line": 5,
"column": 13,
"offset": 162
},
"indent": []
}
},
{
"type": "text",
"value": " - The patch version",
"position": {
"start": {
"line": 5,
"column": 13,
"offset": 162
},
"end": {
"line": 5,
"column": 33,
"offset": 182
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 6,
"offset": 155
},
"end": {
"line": 5,
"column": 33,
"offset": 182
},
"indent": []
}
}
],
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 150
},
"end": {
"line": 5,
"column": 33,
"offset": 182
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "suffix",
"position": {
"start": {
"line": 6,
"column": 6,
"offset": 188
},
"end": {
"line": 6,
"column": 14,
"offset": 196
},
"indent": []
}
},
{
"type": "text",
"value": " - Any additional version information, such as ",
"position": {
"start": {
"line": 6,
"column": 14,
"offset": 196
},
"end": {
"line": 6,
"column": 61,
"offset": 243
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "beta3",
"position": {
"start": {
"line": 6,
"column": 61,
"offset": 243
},
"end": {
"line": 6,
"column": 68,
"offset": 250
},
"indent": []
}
}
],
"position": {
"start": {
"line": 6,
"column": 6,
"offset": 188
},
"end": {
"line": 6,
"column": 68,
"offset": 250
},
"indent": []
}
}
],
"position": {
"start": {
"line": 6,
"column": 1,
"offset": 183
},
"end": {
"line": 6,
"column": 68,
"offset": 250
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 84
},
"end": {
"line": 6,
"column": 68,
"offset": 250
},
"indent": [
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 6,
"column": 68,
"offset": 250
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "WatchInfo",
"kind": "typedef"
}
],
"namespace": "PebbleWatchInfo"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The structure of an app glance.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 32,
"offset": 31
}
}
},
"tags": [
{
"title": "typedef",
"description": null,
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "AppGlanceSlice"
},
{
"title": "memberof",
"description": "Pebble",
"lineNumber": 2
},
{
"title": "desc",
"description": "The structure of an app glance.",
"lineNumber": 4
},
{
"title": "property",
"description": "Optional ISO date-time string of when \nthe entry should expire and no longer be shown in the app glance.",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "expirationTime"
},
{
"title": "property",
"description": "An object containing:\n * `icon` - URI string of the icon to display in the app glance, e.g. system://images/ALARM_CLOCK.\n * `subtitleTemplateString` - Template string that will be displayed in the subtitle of the app glance.",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "Object"
},
"name": "layout"
}
],
"loc": {
"start": {
"line": 401,
"column": 0
},
"end": {
"line": 412,
"column": 2
}
},
"context": {
"loc": {
"start": {
"line": 264,
"column": 0
},
"end": {
"line": 264,
"column": 35
}
},
"file": "/Users/devsite/Pebble/developer.getpebble.com/js-docs/pkjs/Pebble.js"
},
"kind": "typedef",
"name": "AppGlanceSlice",
"type": {
"type": "NameExpression",
"name": "Object"
},
"memberof": "Pebble",
"properties": [
{
"name": "expirationTime",
"lineNumber": 6,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Optional ISO date-time string of when \nthe entry should expire and no longer be shown in the app glance.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 104
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 104
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 66,
"offset": 104
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
}
},
{
"name": "layout",
"lineNumber": 8,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "An object containing:",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
},
{
"type": "list",
"ordered": false,
"start": null,
"loose": false,
"children": [
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "icon",
"position": {
"start": {
"line": 2,
"column": 6,
"offset": 27
},
"end": {
"line": 2,
"column": 12,
"offset": 33
},
"indent": []
}
},
{
"type": "text",
"value": " - URI string of the icon to display in the app glance, e.g. system://images/ALARM_CLOCK.",
"position": {
"start": {
"line": 2,
"column": 12,
"offset": 33
},
"end": {
"line": 2,
"column": 101,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 6,
"offset": 27
},
"end": {
"line": 2,
"column": 101,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 22
},
"end": {
"line": 2,
"column": 101,
"offset": 122
},
"indent": []
}
},
{
"type": "listItem",
"loose": false,
"checked": null,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "subtitleTemplateString",
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 128
},
"end": {
"line": 3,
"column": 30,
"offset": 152
},
"indent": []
}
},
{
"type": "text",
"value": " - Template string that will be displayed in the subtitle of the app glance.",
"position": {
"start": {
"line": 3,
"column": 30,
"offset": 152
},
"end": {
"line": 3,
"column": 106,
"offset": 228
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 6,
"offset": 128
},
"end": {
"line": 3,
"column": 106,
"offset": 228
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 123
},
"end": {
"line": 3,
"column": 106,
"offset": 228
},
"indent": []
}
}
],
"position": {
"start": {
"line": 2,
"column": 1,
"offset": 22
},
"end": {
"line": 3,
"column": 106,
"offset": 228
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 106,
"offset": 228
}
}
},
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"members": {
"instance": [],
"static": []
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
},
{
"name": "AppGlanceSlice",
"kind": "typedef"
}
],
"namespace": "PebbleAppGlanceSlice"
}
]
},
"path": [
{
"name": "Pebble",
"kind": "namespace"
}
],
"namespace": "Pebble"
}
]
Reference in a new issue View git blame Copy permalink