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
	finesse.restservices.Dialogs()

Field Summary
Field Attributes	Field Name and Description
	includeNonVoice if includeNonVoice is true then voice and non-voice both the dialogs will be loaded
	REQUESTID_REAPER_TIMEOUT The requestId reaper timeout in ms

Fields borrowed from class finesse.restservices.RestBase:: ajaxRequestTimeout, restResponseStatus

Method Summary
Method Attributes	Method Name and Description
	getDialogCount(excludeSilentMonitor) Utility method to get the number of dialogs in this collection.
	getRestUrlAdditionalParameters()

Methods borrowed from class finesse.restservices.RestCollectionBase:: getCollection, refresh
Methods borrowed from class finesse.restservices.RestBase:: addHandler, getBaseRestUrl, 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

Field Detail

includeNonVoice

if includeNonVoice is true then voice and non-voice both the dialogs will be loaded

REQUESTID_REAPER_TIMEOUT

The requestId reaper timeout in ms

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.

getRestUrlAdditionalParameters()

Classes

Class finesse.restservices.Dialogs