Class Index | File Index

Classes


Class finesse.restservices.Dialogs


Extends finesse.restservices.RestCollectionBase.
JavaScript representation of a Dialogs collection object. Also exposes methods to operate on the object against the server.
Defined in: finesse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
getDialogCount(excludeSilentMonitor)
Utility method to get the number of dialogs in this collection.
Methods borrowed from class finesse.restservices.RestCollectionBase:
getCollection, refresh
Methods borrowed from class finesse.restservices.RestBase:
addHandler, getData, getId, getProperty, hasProperty, isLoaded, removeHandler
Class Detail
finesse.restservices.Dialogs()
 _dialogs = _user.getDialogs( {
     onCollectionAdd : _handleDialogAdd,
     onCollectionDelete : _handleDialogDelete,
     onLoad : _handleDialogsLoaded
 });
 
_dialogCollection = _dialogs.getCollection();
for (var dialogId in _dialogCollection) {
    if (_dialogCollection.hasOwnProperty(dialogId)) {
        _dialog = _dialogCollection[dialogId];
        etc...
    }
}
See:
finesse.restservices.Dialog
Method Detail
{Number} getDialogCount(excludeSilentMonitor)
Utility method to get the number of dialogs in this collection. 'excludeSilentMonitor' flag is provided as an option to exclude calls with type 'SUPERVISOR_MONITOR' from the count.
Parameters:
{Boolean} excludeSilentMonitor
If true, calls with type of 'SUPERVISOR_MONITOR' will be excluded from the count.
Returns:
{Number} The number of dialogs in this collection.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Feb 23 2017 02:41:30 GMT-0500 (EST)