pebble-timeline-js-node
v1.1.0
Published
Node library to push Pebble timeline pins and set AppGlances
Downloads
5
Readme
pebble-timeline-js-node
Node.js module for pushing shared (topic) pins to app users.
Installation
npm install --save pebble-timeline-js-node
Methods
insertSharedPin(pin, topics, apiKey, callback)
- insert a shared pin for the topics in the topics
array.
deleteSharedPin(pin, topics, apiKey, callback)
- delete a previously pushed pin.
insertUserPin(pin, userToken, callback)
- insert a timeline pin for the user running the app.
deleteUserPin(pin, userToken, callback)
- delete a pin previously pushed. The id
must match.
setAppGlances(slices, userToken, callback)
- set the current collection of AppGlance slice objects. Requires the user's timeline token, obtained using PebbleKit JS.
userToken
must be received from each client app that connects to this server. The developer is responsible for handling this.
Example Usage
Push a shared pin
var timelinejs = require('pebble-timeline-js-node');
var pin = {
id: 'example-pin-generic-d2sd3d5bdsd',
time: new Date().toISOString(),
layout: {
type: 'genericPin',
title: 'timelinejs shared pin test',
tinyIcon: 'system://images/NOTIFICATION_FLAG'
}
};
var topics = ['default'];
var apiKey = 'REDACTED';
timelinejs.insertSharedPin(pin, topics, apiKey, function(responseText) {
console.log('Result: ' + responseText);
});
Set an AppGlance
var slices = [
{
layout: {
subtitleTemplateString: 'Hello from AppGlance REST!'
}
}
];
var userToken = 'REDACTED';
timelinejs.setAppGlances(slices, userToken, function(responseText) {
console.log('AppGlance result: ' + responseText);
});