Class Index | File Index

Classes


Class finesse.clientservices.ClientServices

Allow clients to make Finesse API requests and consume Finesse events by calling a set of exposed functions. The Services layer will do the dirty work of establishing a shared BOSH connection (for designated Master modules), consuming events for client subscriptions, and constructing API requests.
Defined in: ClientServices.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
finesse.clientservices.ClientServices.addToRefreshList(object)
Adds an item to the list to be refreshed upon reconnect
<static>  
finesse.clientservices.ClientServices.getTunnelURL()
The location of the tunnel HTML URL.
<static>  
finesse.clientservices.ClientServices.init(config)
Initiates the Client Services with the specified config parameters.
<static>  
finesse.clientservices.ClientServices.removeFromRefreshList(object)
Removes the given item from the refresh list
<static>  
finesse.clientservices.ClientServices.setLogger(logger)
Set's the global logger for this Client Services instance.
Class Detail
finesse.clientservices.ClientServices()
Method Detail
<static> finesse.clientservices.ClientServices.addToRefreshList(object)
Adds an item to the list to be refreshed upon reconnect
Parameters:
{RestBase} object
- rest object to be refreshed

<static> {String} finesse.clientservices.ClientServices.getTunnelURL()
The location of the tunnel HTML URL.
Returns:
{String} The location of the tunnel HTML URL.

<static> finesse.clientservices.ClientServices.init(config)
Initiates the Client Services with the specified config parameters. Enabling the Client Services as Master will trigger the establishment of a BOSH event connection.
Parameters:
{Object} config
Configuration object containing properties used for making REST requests:
  • host: The Finesse server IP/host as reachable from the browser
  • restHost: The Finesse API IP/host as reachable from the gadget container
  • id: The ID of the user. This is an optional param as long as the appropriate authorization string is provided, otherwise it is required.
  • password: The password belonging to the user. This is an optional param as long as the appropriate authorization string is provided, otherwise it is required.
  • authorization: The base64 encoded "id:password" authentication string. This param is provided to allow the ability to hide the password param. If provided, the id and the password extracted from this string will be used over the config.id and config.password.
Throws:
{Error}
If required constructor parameter is missing.

<static> finesse.clientservices.ClientServices.removeFromRefreshList(object)
Removes the given item from the refresh list
Parameters:
{RestBase} object
- rest object to be removed

<static> finesse.clientservices.ClientServices.setLogger(logger)
Set's the global logger for this Client Services instance.
Parameters:
{Object} logger
Logger object with the following attributes defined:
  • log: function (msg) to simply log a message

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Jul 24 2013 18:47:09 GMT-0400 (EDT)