Class finesse.restservices.SystemInfo
JavaScript representation of a SystemInfo object. Also exposes methods to operate
on the object against the server.
Defined in: SystemInfo.js.
Constructor Attributes | Constructor Name and Description |
---|---|
finesse.restservices.SystemInfo(options, callbacks, restObj)
|
Field Attributes | Field Name and Description |
---|---|
<static> |
finesse.restservices.SystemInfo.Statuses
State constants
|
Method Attributes | Method Name and Description |
---|---|
Returns the status coresponding to this SystemInfo object:
IN_SERVICE if the Finesse API reports that it is in service,
OUT_OF_SERVICE otherwise.
|
|
Getter for the xmpp domain of the system
|
|
Getter for the xmpp pubsub domain of the system
|
Class Detail
finesse.restservices.SystemInfo(options, callbacks, restObj)
- Parameters:
- {Object} options
- An object with the following properties:
- id: The id of the object being constructed
- onLoad(this): (optional) when the object is successfully loaded from the server
- onChange(this): (optional) when an update notification of the object is received
- onAdd(this): (optional) when a notification that the object is created is received
- onDelete(this): (optional) when a notification that the object is deleted is received
- onError(rsp): (optional) if loading of the object fails, invoked with the error response object:
- status: {Number} The HTTP status code returned
- content: {String} Raw string of response
- object: {Object} Parsed object of response
- error: {Object} Wrapped exception that was caught:
- errorType: {String} Type of error that was caught
- errorMessage: {String} Message associated with error
- parentObj: (optional) The parent object
- callbacks
- restObj
Field Detail
<static>
finesse.restservices.SystemInfo.Statuses
State constants
Method Detail
getStatus()
Returns the status coresponding to this SystemInfo object:
IN_SERVICE if the Finesse API reports that it is in service,
OUT_OF_SERVICE otherwise.
{String}
getXmppDomain()
Getter for the xmpp domain of the system
- Returns:
- {String} The xmpp domain coresponding to this SystemInfo object
{String}
getXmppPubSubDomain()
Getter for the xmpp pubsub domain of the system
- Returns:
- {String} The xmpp pubsub domain coresponding to this SystemInfo object: