jive-sdk
Version:
Node.js SDK for Jive Software to assist with the development of add-ons
314 lines (241 loc) • 9.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Jive SDK Source: jive-sdk-api/lib/util/constants.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/util/constants.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.
*/
/**
* @module constants
*/
/**
* @property {String} PUSH_DATA_TO_JIVE <b>pushDataToJive</b> Fired on request to push tile data update to Jive.
* @property {String} PUSH_ACTIVITY_TO_JIVE Fired on request to push externatstream activity to Jive.
* @property {String} PUSH_COMMENT_TO_JIVE Fired on request to push a comment into Jive.
* @property {String} COMMENT_ON_ACTIVITY Fired on request to push a comment on an activity entry into Jive.
* @property {String} COMMENT_ON_ACTIVITY_BY_EXTERNAL_ID Fired on request to push a comment on an activity entry into Jive.
* @property {String} FETCH_COMMENTS_ON_ACTIVITY Fired on request for activity comments from Jive.
* @property {String} FETCH_ALL_COMMENTS_FOR_EXT_STREAM Fired on request for activity comments from Jive.
* @property {String} INSTANCE_REGISTRATION Fired on request to register a new tile or externalstream instance.
* @property {String} INSTANCE_UNREGISTRATION Fired on request to destroy a tile or externalstream instance.
* @property {String} CLIENT_APP_REGISTRATION Fired on request to register a Jive instance on the service.
* @property {String} GET_PAGINATED_RESULTS Fired on request for paginated results from a Jive service.
* @property {String} GET_EXTERNAL_PROPS Fired on request for retrieving external props on a tile or externalstream instance.
* @property {String} SET_EXTERNAL_PROPS Fired on request for setting external props on a tile or externalstream instance.
* @property {String} DELETE_EXTERNAL_PROPS Fired on request for deleting external props on a tile or externalstream instance.
*/
exports.tileEventNames = {
'PUSH_DATA_TO_JIVE':'pushDataToJive',
'PUSH_ACTIVITY_TO_JIVE':'pushActivityToJive',
'PUSH_COMMENT_TO_JIVE':'pushCommentToJive',
'COMMENT_ON_ACTIVITY':'commentOnActivity',
'COMMENT_ON_ACTIVITY_BY_EXTERNAL_ID':'commentOnActivityByExternalID',
'FETCH_COMMENTS_ON_ACTIVITY':'fetchCommentsOnActivity',
'FETCH_ALL_COMMENTS_FOR_EXT_STREAM':'fetchAllCommentsForExtstream',
'INSTANCE_REGISTRATION':'registration',
'INSTANCE_UNREGISTRATION':'unregistration',
'CLIENT_APP_REGISTRATION':'clientAppRegistration',
'GET_PAGINATED_RESULTS':'getPaginatedResults',
'GET_EXTERNAL_PROPS':'getExternalProps',
'SET_EXTERNAL_PROPS':'setExternalProps',
'DELETE_EXTERNAL_PROPS':'deleteExternalProps'
};
/**
* @property {String} NEW_INSTANCE Fired when a new tile or externalstream instance is created.
* @property {String} INSTANCE_UPDATED Fired when a tile or externalstream instance is updated.
* @property {String} INSTANCE_REMOVED Fired when a tile or externalstream instance is destroyed.
* @property {String} DATA_PUSHED Fired when a tile instance updated is pushed into Jive.
* @property {String} ACTIVITY_PUSHED Fired when an externalstream instance is pushed into Jive.
* @property {String} COMMENT_PUSHED Fired when an externalstream instance comment is pushed into Jive.
* @property {String} CLIENT_APP_REGISTRATION_SUCCESS Fired when a community registers itself with the addon service successfully.
* @property {String} CLIENT_APP_REGISTRATION_FAILED Fired when a community registers itself with the addon service unsuccessfully.
*/
exports.globalEventNames = {
'NEW_INSTANCE':'newInstance',
'INSTANCE_UPDATED':'updateInstance',
'INSTANCE_REMOVED':'destroyedInstance',
'DATA_PUSHED':'dataPushed',
'ACTIVITY_PUSHED':'activityPushed',
'COMMENT_PUSHED':'commentPushed',
'CLIENT_APP_REGISTRATION_SUCCESS' : 'registeredJiveInstanceSuccess',
'CLIENT_APP_REGISTRATION_FAILED' : 'registeredJiveInstanceFailed'
};
/**
* @property {String} WORKER Worker nodes typically do not handle HTTP requests, and are concerned mostly with background tasks.
* @property {String} PUSHER A subspecies of WORKER node, specializing in making HTTP requests.
* @property {String} HTTP_HANDLER HTTP handler nodes specialize in accepting incoming requests, and possibly forwarding them for further processing.
*/
exports.roles = {
'WORKER':'worker',
'PUSHER':'pusher',
'HTTP_HANDLER':'http'
};
/**
* This is the string normally appended to incoming v3 entities, for the purpose of thwarting security threats: <br>
* throw 'allowIllegalResourceCall is false.';
* @type {string}
*/
exports.SECURITY_STRING = "throw 'allowIllegalResourceCall is false.';\n";</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>