Class: IntegrationService

Wildix.IntegrationService(options)

new IntegrationService(options)

Represents a Wildix IntegrationService instance
Parameters:
Name Type Description
options Object options
Example
var WIService = new Wildix.IntegrationService({
  name: "MySomeApplication",
  version: '1.0.0'
}

Extends

Members

Chat :Wildix.Chat

Plugin that provides Chat functionality
Type:

Roster :Wildix.Roster

Plugin that provides Roster functionality
Type:

Telephony :Wildix.Telephony

Plugin that provides Telephony functionality
Type:

Methods

getCollaborationStatus() → {string|null}

Return collaboration status or null if IntegrationService not connected to the WIService.
Returns:
Type
string | null

getConnection() → {Wildix.Connector}

Return connection to WIService.
Returns:
Type
Wildix.Connector

isConnected() → {boolean}

Return true if IntegrationService connected to the WIService.
Returns:
Type
boolean

isReady() → {boolean}

Return true if fully initialized connection with WIService.
Returns:
Type
boolean

Events

collaboration:connected

Indicates that Collaboration is connected to WIService.
Properties:
Name Type Description
IntegrationService Wildix.IntegrationService
Example
WIService.on('collaboration:connected', function(){
  console.log('Collaboration connected');
});

collaboration:disconnected

Indicates that Collaboration is disconnected from the WIService.
Properties:
Name Type Description
IntegrationService Wildix.IntegrationService
Example
WIService.on('collaboration:disconnected', function(){
  console.log('Collaboration disconnected');
});

connection:error

Indicates that could not connect to WIService.
Properties:
Name Type Description
IntegrationService Wildix.IntegrationService
Example
WIService.on('connection:error', function(){
  console.warn('WIService not installed or is not running');
});

ready

Indicates that collaboration is connected and IntegrationService received status.
Properties:
Name Type Description
IntegrationService Wildix.IntegrationService
Example
WIService.on('ready', function(){
  var status = WIService.getCollaborationStatus();
  if(status == 'disconnected'){
      console.warn('Collaboration not running');
  }
});