jive-sdk/test/resources/services/samplesvc/tiles/samplelist/backend/services.js

Node.js SDK for Jive Software to assist with the development of add-ons

/*
 * Copyright 2013 Jive Software
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

var jive = require("jive-sdk");
var q = require('q');

/**
 * Handles actually pushing data to the tile instance
 * @param instance
 */
function processTileInstance(instance) {
    jive.logger.debug('running pusher for ', instance.name, 'instance', instance.id);

    // creates a data update structure
    function getFormattedData(count) {
        return {
            data: {
                "title": "Simple Counter",
                "contents": [
                    {
                        "text": "Current count: " + count,
                        "icon": "https://community.jivesoftware.com/servlet/JiveServlet/showImage/102-99994-1-1023036/j.png",
                        "linkDescription": "Current counter."
                    }
                ],
                "config": {
                    "listStyle": "contentList"
                },
                "action": {
                    "text": "Share State",
                    "context": {
                        "count": count
                    }
                }
            }
        };
    }

    var store = jive.service.persistence();
    return store.find('exampleStore', { 'key': 'count' } ).then(function(found) {
        found = found.length > 0 ? found[0].count : parseInt(instance.config.startSequence, 10);

        store.save('exampleStore', 'count', {
            'key':'count',
            'count':found + 1
        }).then(function() {
            return jive.tiles.pushData(instance, getFormattedData(found));
        });
    }, function(err) {
        jive.logger.debug('Error encountered, push failed', err);
    });
}

/**
 * Iterates through the tile instances registered in the service, and pushes an update to it
 */
var pushData = function() {
    var deferred = q.defer();
    jive.tiles.findByDefinitionName('samplelist').then(function(instances) {
        if (instances) {
            q.all(instances.map(processTileInstance)).then(function() {
                deferred.resolve(); //success
            }, function() {
                deferred.reject(); //failure
            });
        } else {
            jive.logger.debug("No jive instances to push to");
            deferred.resolve();
        }
    });
    return deferred.promise;
};

/**
 * Schedules the tile update task to automatically fire every 10 seconds
 */
exports.task = [
    {
        'interval' : 1000,
        'handler' : pushData
    },
    {
        'interval' : 10,
        'handler' : function() {
            // inline handler
            var testDataKey = jive.service.options['__testDataKey'];
            if ( testDataKey ) {
                jive.service.options[testDataKey] = jive.util.guid();
            }
        }
    },

    {
        'interval' : 10,
        'event' :  'customSelfServiceEvent'
    }
];

/**
 * Defines event handlers for the tile life cycle events
 */
exports.eventHandlers = [

    // process tile instance whenever a new one is registered with the service
    {
        'event' : jive.constants.globalEventNames.NEW_INSTANCE,
        'handler' : processTileInstance
    },

    // process tile instance whenever an existing tile instance is updated
    {
        'event' : jive.constants.globalEventNames.INSTANCE_UPDATED,
        'handler' : processTileInstance
    },

    {
        'event' : 'customServiceEvent',
        'handler' : function(context) {
            // inline handler
            // echoes it out
            return q.resolve(context);
        }
    },

    {
        'event' : 'customSelfServiceEvent',
        'handler' : function(context) {
            var testDataKey = jive.service.options['__testDataKeyCustomSelfServiceEvent'];
            if ( testDataKey ) {
                jive.service.options[testDataKey] = jive.util.guid();
            }

            return q.resolve(context);
        }
    }
];