Jive SDK

Module: api

api

Main entrypoint of the Jive SDK API.
Example Usage:

     var jive = require('jive-sdk');
     jive.logger.info('Welcome!');
Source:

Members

<static> community :module:community

API for managing jive communities.

Example Usage:

    var jive = require('jive-sdk');
    jive.community.findByTenantID( '8sakjhdfee1' ).then( function(community) {
         jive.logger.info('Found',JSON.stringify(community));
    });
Type:
Source:

<static> constants :module:constants

An object containing constant string values. @see constants.

Type:
Source:

<static> context :Object

Object that contains nominal API configuration state.

Type:
  • Object
Properties:
Name Type Description
persistence object

Configured persistence strategy.
scheduler object

Configured scheduler strategy.
config object

Configuration options.
Source:

<static> events :module:events

API for managing events.

Type:
Source:

<static> extstreams :module:extstreamsInstances

API for manipulating external streams and tiles (instances and definitions).

Example Usage:

    var jive = require('jive-sdk');
    jive.extstreams.findByID( ... );
    jive.extstreams.definitions.findByID( ... );
Type:
Properties:
Name Type Description
definitions extstreamsDefinitions

Stream definitions API.
Source:

<static> logger :Logger

Instance of the default logger.

Type:
  • Logger
Properties:
Name Type Description
debug function

example: require('jive-sdk').logger.debug('Debug message');
info function

example: require('jive-sdk').logger.debug('Info message');
warn function

example: require('jive-sdk').logger.debug('Warn message');
fatal function

example: require('jive-sdk').logger.debug('Fatal message');
error function

example: require('jive-sdk').logger.debug('Error message');
Source:

<static> oauthUtil :Object

Type:
  • Object
Deprecated:
  • Yes
Source:

<static> persistence :Object

An object containing the available default persistence strategies.


Example Usage:

    var jive = require('jive-sdk');
    var persistence = new jive.persistence.memory();
    persistence.save( ... );
Type:
  • Object
Properties:
Name Type Description
file filePersistence

File based persistence. @see filePersistence persistence.
memory memoryPersistence

Memory based persistence @see memoryPersistence persistence.
Source:

<static> scheduler :memoryScheduler

An object containing the available default scheduling strategy types.


Example Usage:

    var jive = require('jive-sdk');
    var scheduler = new jive.scheduler.memory();
    ...
    ...
    scheduler.schedule( ... );
Type:
Source:

<static> service :module:service

API for managing an SDK service.

Type:
Source:

<static> tasks :module:tasks

API for managing tasks.

Type:
Source:

<static> tiles :module:tileInstances

API for manipulating tiles (instances and definitions).
Example Usage:

    var jive = require('jive-sdk');
    jive.tiles.findByID( ... );
    jive.tiles.definitions.findByID( ... );
Type:
Properties:
Name Type Description
definitions tilesDefinitions

Tiles definitions API.
Source:

<static> util :module:jiveutil

Useful general purpose utility functions.
Example Usage:

    var jive = require('jive-sdk');
    var guid = jive.util.guid();
Type:
Source:

<static> webhooks :module:webhooks

API For managing service webhooks

Type:
Source: