jive-sdk
Version:
Node.js SDK for Jive Software to assist with the development of add-ons
1,665 lines (656 loc) • 25 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Jive SDK Module: api</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="span8">
<div id="main">
<h1 class="page-title">Module: api</h1>
<section>
<header>
<h2>
api
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Main entrypoint of the Jive SDK API.<br>
Example Usage:</p>
<pre>
var jive = require('jive-sdk');
jive.logger.info('Welcome!');
</pre></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-17">line 17</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="community"><span class="type-signature"><static> </span>community<span class="type-signature"> :<a href="module-community.html">module:community</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for managing jive communities.
<br><br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
jive.community.findByTenantID( '8sakjhdfee1' ).then( function(community) {
jive.logger.info('Found',JSON.stringify(community));
});
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-community.html">module:community</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-150">line 150</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="constants"><span class="type-signature"><static> </span>constants<span class="type-signature"> :<a href="module-constants.html">module:constants</a></span></h4>
</dt>
<dd>
<div class="description">
<p>An object containing constant string values. @see constants.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-constants.html">module:constants</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-82">line 82</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="context"><span class="type-signature"><static> </span>context<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
<p>Object that contains nominal API configuration state.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>persistence</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Configured persistence strategy.</p></td>
</tr>
<tr>
<td class="name"><code>scheduler</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Configured scheduler strategy.</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Configuration options.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-182">line 182</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="events"><span class="type-signature"><static> </span>events<span class="type-signature"> :<a href="module-events.html">module:events</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for managing events.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-events.html">module:events</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-118">line 118</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="extstreams"><span class="type-signature"><static> </span>extstreams<span class="type-signature"> :<a href="module-extstreamsInstances.html">module:extstreamsInstances</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for manipulating external streams and tiles (instances and definitions).
<br><br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
jive.extstreams.findByID( ... );
jive.extstreams.definitions.findByID( ... );
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-extstreamsInstances.html">module:extstreamsInstances</a></span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>definitions</code></td>
<td class="type">
<span class="param-type"><a href="extstreamsDefinitions.html">extstreamsDefinitions</a></span>
</td>
<td class="description last"><p>Stream definitions API.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="logger"><span class="type-signature"><static> </span>logger<span class="type-signature"> :Logger</span></h4>
</dt>
<dd>
<div class="description">
<p>Instance of the default logger.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Logger</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>debug</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>example: require('jive-sdk').logger.debug('Debug message');</p></td>
</tr>
<tr>
<td class="name"><code>info</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>example: require('jive-sdk').logger.debug('Info message');</p></td>
</tr>
<tr>
<td class="name"><code>warn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>example: require('jive-sdk').logger.debug('Warn message');</p></td>
</tr>
<tr>
<td class="name"><code>fatal</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>example: require('jive-sdk').logger.debug('Fatal message');</p></td>
</tr>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>example: require('jive-sdk').logger.debug('Error message');</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-41">line 41</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="oauthUtil"><span class="type-signature"><static> </span>oauthUtil<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="persistence"><span class="type-signature"><static> </span>persistence<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
<p>An object containing the available default persistence strategies.<br>
<br><br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
var persistence = new jive.persistence.memory();
persistence.save( ... );
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>file</code></td>
<td class="type">
<span class="param-type"><a href="filePersistence.html">filePersistence</a></span>
</td>
<td class="description last"><p>File based persistence. @see <a href="filePersistence.html">filePersistence</a> persistence.</p></td>
</tr>
<tr>
<td class="name"><code>memory</code></td>
<td class="type">
<span class="param-type"><a href="memoryPersistence.html">memoryPersistence</a></span>
</td>
<td class="description last"><p>Memory based persistence @see <a href="memoryPersistence.html">memoryPersistence</a> persistence.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-56">line 56</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="scheduler"><span class="type-signature"><static> </span>scheduler<span class="type-signature"> :<a href="memoryScheduler.html">memoryScheduler</a></span></h4>
</dt>
<dd>
<div class="description">
<p>An object containing the available default scheduling strategy types.<br>
<br><br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
var scheduler = new jive.scheduler.memory();
...
...
scheduler.schedule( ... );
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="memoryScheduler.html">memoryScheduler</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="service"><span class="type-signature"><static> </span>service<span class="type-signature"> :<a href="module-service.html">module:service</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for managing an SDK service.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-service.html">module:service</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-190">line 190</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="tasks"><span class="type-signature"><static> </span>tasks<span class="type-signature"> :<a href="module-tasks.html">module:tasks</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for managing tasks.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-tasks.html">module:tasks</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-162">line 162</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="tiles"><span class="type-signature"><static> </span>tiles<span class="type-signature"> :<a href="module-tileInstances.html">module:tileInstances</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API for manipulating tiles (instances and definitions).
<br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
jive.tiles.findByID( ... );
jive.tiles.definitions.findByID( ... );
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-tileInstances.html">module:tileInstances</a></span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>definitions</code></td>
<td class="type">
<span class="param-type">tilesDefinitions</span>
</td>
<td class="description last"><p>Tiles definitions API.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-111">line 111</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="util"><span class="type-signature"><static> </span>util<span class="type-signature"> :<a href="module-jiveutil.html">module:jiveutil</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Useful general purpose utility functions.
<br>
Example Usage:<br></p>
<pre>
var jive = require('jive-sdk');
var guid = jive.util.guid();
</pre>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-jiveutil.html">module:jiveutil</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-130">line 130</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="webhooks"><span class="type-signature"><static> </span>webhooks<span class="type-signature"> :<a href="module-webhooks.html">module:webhooks</a></span></h4>
</dt>
<dd>
<div class="description">
<p>API For managing service webhooks</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="module-webhooks.html">module:webhooks</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">jive-sdk-api/api.js</a>, <a href="api.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</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:38 GMT-0800 (PST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</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>