Class Index | File Index

Classes


Class finesse.restservices.SignOutReasonCodes

JavaScript representation of a SignOutReasonCodes collection object. Also exposes methods to operate on the object against the server.
Defined in: SignOutReasonCodes.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Specifies that this object should not be refreshed; possible reasons are that it's encapsulating collection already does it
 
Specifies whether this object's subscriptions need to be explicitly requested
Method Summary
Method Attributes Method Name and Description
 
get()
Retrieve the Sign Out Reason Codes.
 
Getter for the queue id
 
Getter for the queue name
 
Gets the REST class for the current object - this is the Queue object.
 
Gets the REST class for the objects that make up the collection.
 
Gets the REST type for the objects that make up the collection - this is "Queue".
 
Gets the REST type for the current object - this is a "Queue".
 
Overrides the parent class.
 
Getter for the queue statistics.
 
Gets the node path for the current object - this is the team Users node
 
init(id, callbacks, restObj)
Initialize the user object.
 
Returns whether this object supports subscriptions
Class Detail
finesse.restservices.SignOutReasonCodes(options)
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
Field Detail
doNotRefresh
Specifies that this object should not be refreshed; possible reasons are that it's encapsulating collection already does it
Defined in: Queue.js.

explicitSubscription
Specifies whether this object's subscriptions need to be explicitly requested
Defined in: Queue.js.
Method Detail
{finesse.restservices.SignOutReasonCodes} get()
Retrieve the Sign Out Reason Codes.
Returns:
{finesse.restservices.SignOutReasonCodes} This ReadyReasonCodes object to allow cascading.

getId()
Getter for the queue id
Defined in: Queue.js.
Returns:
(String) The id of the Queue

getName()
Getter for the queue name
Defined in: Queue.js.
Returns:
(String) The name of the Queue

getRestClass()
Gets the REST class for the current object - this is the Queue object.
Defined in: Queue.js.

getRestItemClass()
Gets the REST class for the objects that make up the collection. - this is the Queue class.
Defined in: Queues.js.

getRestItemType()
Gets the REST type for the objects that make up the collection - this is "Queue".
Defined in: Queues.js.

getRestType()
Gets the REST type for the current object - this is a "Queue".
Defined in: Queue.js.

getRestUrl()
Overrides the parent class. Returns the url for the SignOutReasonCodes resource

getStatistics()
Getter for the queue statistics. Supported statistics include: - callsInQueue - startTimeOfLongestCallInQueue These statistics can be accessed via dot notation: i.e.: getStatistics().callsInQueue
Defined in: Queue.js.
Returns:
(Object) The Object with different statistics as properties.

{String} getXMPPNodePath()
Gets the node path for the current object - this is the team Users node
Defined in: Queue.js.
Returns:
{String} The node path

init(id, callbacks, restObj)
Initialize the user object.
Defined in: Queue.js.
Parameters:
id
is the REST id
callbacks
are the callback handlers (onLoad & onError)
restObj

supportsSubscriptions()
Returns whether this object supports subscriptions
Defined in: Queue.js.

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