jive-sdk
Version:
Node.js SDK for Jive Software to assist with the development of add-ons
372 lines (288 loc) • 10.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Jive SDK Source: jive-sdk-api/lib/tile/extstreams.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Jive SDK</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="module-abstractDefinitions.html">abstractDefinitions</a>
</li>
<li>
<a href="module-abstractInstances.html">abstractInstances</a>
</li>
<li>
<a href="module-addOnRoutes.html">addOnRoutes</a>
</li>
<li>
<a href="module-api.html">api</a>
</li>
<li>
<a href="module-community.html">community</a>
</li>
<li>
<a href="module-constants.html">constants</a>
</li>
<li>
<a href="module-devRoutes.html">devRoutes</a>
</li>
<li>
<a href="module-events.html">events</a>
</li>
<li>
<a href="module-extensions.html">extensions</a>
</li>
<li>
<a href="module-extstreamsInstances.html">extstreamsInstances</a>
</li>
<li>
<a href="module-jiveutil.html">jiveutil</a>
</li>
<li>
<a href="module-oauthRoutes.html">oauthRoutes</a>
</li>
<li>
<a href="module-request.html">request</a>
</li>
<li>
<a href="module-security.html">security</a>
</li>
<li>
<a href="module-service.html">service</a>
</li>
<li>
<a href="module-tasks.html">tasks</a>
</li>
<li>
<a href="module-tileInstances.html">tileInstances</a>
</li>
<li>
<a href="module-tileRoutes.html">tileRoutes</a>
</li>
<li>
<a href="module-tilesDefinitions.html">tilesDefinitions</a>
</li>
<li>
<a href="module-webhooks.html">webhooks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="extstreamsDefinitions.html">extstreamsDefinitions</a>
</li>
<li>
<a href="filePersistence.html">filePersistence</a>
</li>
<li>
<a href="memoryPersistence.html">memoryPersistence</a>
</li>
<li>
<a href="memoryScheduler.html">memoryScheduler</a>
</li>
<li>
<a href="oauthHandler.html">oauthHandler</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: jive-sdk-api/lib/tile/extstreams.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/*
* 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.
*/
/**
* Library for manipulating external stream instances.
* @extends module:abstractInstances
* @module extstreamsInstances
*/
///////////////////////////////////////////////////////////////////////////////////
// private
var q = require('q');
var util = require('util');
var jive = require('../../api');
var instances = require('./instances');
var pusher = require('./dataPusher');
var extstreams = Object.create(instances);
///////////////////////////////////////////////////////////////////////////////////
// public
module.exports = extstreams;
extstreams.getCollection = function() {
return "extstreamInstance";
};
/**
* @memberof module:extstreamsInstances
* @param {Object} tileInstance
* @param {Object} activity
* @returns {Promise} Promise
*/
extstreams.pushActivity = function ( tileInstance, activity) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.PUSH_ACTIVITY_TO_JIVE, {
'tileInstance' : tileInstance,
'activity' : activity
} );
};
var pushComment = function ( tileInstance, comment, commentURL) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.PUSH_COMMENT_TO_JIVE, {
'tileInstance' : tileInstance,
'commentURL' : commentURL,
'comment' : comment
} );
};
/**
* Create a comment in Jive on an activity that was generated by an external stream.
* @memberof module:extstreamsInstances
* @param {Object} activity - activity object returned from jive. For example, an object returned in the promise by extstreams.pushActivity method
* @param {Object} comment - comment JSON, see https://developers.jivesoftware.com/api/rest/CommentEntity.html
* @returns {Promise} Promise that resolves with a response object. response.entity is the created comment that is returned from Jive
*/
extstreams.commentOnActivity = function(activity, comment ) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.COMMENT_ON_ACTIVITY, {
'activity' : activity,
'comment' : comment
} );
};
/**
* Create a comment on an activity using this endpoint---
* http://mycomany.jiveon.com/api/jivelinks/v1/extstreams/1234/extactivities/{externalActivityID}/comments
* @memberof module:extstreamsInstances
* @param {String} externalActivityID
* @param {Object} extstream
* @param {Object} comment
* @returns {Promise} Promise
*/
extstreams.commentOnActivityByExternalID = function(extstream, externalActivityID, comment) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.COMMENT_ON_ACTIVITY_BY_EXTERNAL_ID, {
'extstream' : extstream,
'externalActivityID' : externalActivityID,
'comment' : comment
} );
};
//Change default options here
var DEFAULT_OPTS = {
commentSourceType: "ALL"
};
/**
*
* Options for the following methods look like:
* var opts = {
* "fieldList": ["content", "parent", "resources" ], // list of fields to be returned on Jive entity
* "itemsPerPage": 100, // for paginated requests, the no. of items to return per request
* "commentSourceType": "JIVE", // Must be "JIVE" or "EXTERNAL" or "ALL". Defaults to "ALL"
* "publishedAfter": 1367968760257 // Get comments that were created after this time only
* }
*/
/**
* Get all the comments in Jive for a given activity object.
* @memberof module:extstreamsInstances
* @param {Object} activity - activity object
* @param {Object} opts - JSON describing options for retrieving content from Jive. See above documentation.
* @returns {Promise} Promise A promise that resolves to a response. response.entity is the list of comments. See See https://developers.jivesoftware.com/api/rest/index.html#lists
*/
extstreams.fetchCommentsOnActivity = function(activity, opts) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.FETCH_COMMENTS_ON_ACTIVITY, {
'activity' : activity,
'opts' : opts || DEFAULT_OPTS
} );
};
/**
* Get all comments in Jive for ALL activity of the given external stream
* Note pagination (next) operations are always performed inline, never on a separate node
* @memberof module:extstreamsInstances
* @param {Object} extstream - an external stream object from the jive-sdk
* @param {Object} opts - JSON describing options for retrieving content from Jive. See above documentation.
* @returns {Promise} Promise A promise that resolves to a response. response.entity is the list of comments. See See https://developers.jivesoftware.com/api/rest/index.html#lists
*/
extstreams.fetchAllCommentsForExtstream = function(extstream, opts) {
return jive.context.scheduler.schedule(jive.constants.tileEventNames.FETCH_ALL_COMMENTS_FOR_EXT_STREAM, {
'extstream' : extstream,
'opts' : opts || DEFAULT_OPTS
}).then( function(response) {
var entity = response.entity;
var instance = response.instance;
entity.next = function() {
return pusher.getPaginated(instance, entity.links.next);
};
return {
'entity' : entity
};
});
};
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Jive Software, Inc
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Wed Jan 22 2014 12:29:37 GMT-0800 (PST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>