Module: events

Members

<static> systemEvents

This is a map of system defined events to their respective event handlers.

Properties:

Name	Type	Description
NEW_INSTANCE	Object	Fired on request to push tile data update to Jive. Properties Name Type Description handler function Logs the request context
INSTANCE_UPDATED	Object	Fired on request to push tile data update to Jive. Properties Name Type Description handler function Logs the request context
INSTANCE_REMOVED	Object	Fired on request to push tile data update to Jive. Properties Name Type Description handler function Logs the request context
PUSH_DATA_TO_JIVE	Object	Fired on request to push tile data update to Jive. Properties Name Type Description handler function Passed context contains theInstance and data attributes. These are used to push a tile update into Jive.
PUSH_ACTIVITY_TO_JIVE	Object	Fired on request to push externatstream activity to Jive. Properties Name Type Description handler function Passed context contains theInstance and activity attributes. These are used to push an extstreamstream activity entry into Jive.
PUSH_COMMENT_TO_JIVE	Object	Fired on request to push a comment into Jive. Properties Name Type Description handler function Logs the request context
COMMENT_ON_ACTIVITY	Object	Fired on request to push a comment on an activity entry into Jive. Properties Name Type Description handler function
COMMENT_ON_ACTIVITY_BY_EXTERNAL_ID	Object	Fired on request to push a comment on an activity entry into Jive. Properties Name Type Description handler function
FETCH_COMMENTS_ON_ACTIVITY	Object	Fired on request for activity comments from Jive. Properties Name Type Description handler function
FETCH_ALL_COMMENTS_FOR_EXT_STREAM	Object	Fired on request for activity comments from Jive. Properties Name Type Description handler function
INSTANCE_REGISTRATION	Object	Fired on request to register a new tile or externalstream instance. Properties Name Type Description handler function
INSTANCE_UNREGISTRATION	Object	Fired on request to destroy a tile or externalstream instance. Properties Name Type Description handler function
CLIENT_APP_REGISTRATION	Object	Fired on request to register a Jive instance on the service. Properties Name Type Description handler function
GET_PAGINATED_RESULTS	Object	Fired on request for paginated results from a Jive service. Properties Name Type Description handler function
GET_EXTERNAL_PROPS	Object	Fired on request for retrieving external props on a tile or externalstream instance. Properties Name Type Description handler function
SET_EXTERNAL_PROPS	Object	Fired on request for setting external props on a tile or externalstream instance. Properties Name Type Description handler function
DELETE_EXTERNAL_PROPS	Object	Fired on request for deleting external props on a tile or externalstream instance. Properties Name Type Description handler function

Source:

• jive-sdk-api/lib/event/events.js, line 256

Methods

<static> addLocalEventListener(event, handler)

Adds a local event handler.

Parameters:

Name	Type	Description
event	String
handler	function

Source:

• jive-sdk-api/lib/event/events.js, line 175

<static> getEventListeners(event, eventListener) → {Array}

Returns array of registered event handling functions for the given event listener and event. Otherwise returns undefined.

Parameters:

Name	Type	Description
event	String
eventListener	String

Source:

• jive-sdk-api/lib/event/events.js, line 121

Returns:

Type

Array

<static> registerEventListener(event, handler, options)

Add an event handler. The handler is invoked when an event is fired which specifies the target event listener and event type, if both are specified in the event firing. If only event is specified, then the handler will be invoked whenever that event is fired.

The handler is added to an array of handler functions assigned for the event listener. Only one function per event listener per event is permitted.

Parameters:

Name	Type	Description
event	String	the event id
handler	function	the function to call
options	object	Properties Name Type Description eventListener String the name of the listener description String

Source:

• jive-sdk-api/lib/event/events.js, line 86

<static> reset()

Removes all event handlers.

Source:

• jive-sdk-api/lib/event/events.js, line 420