Dialogs

Class finesse.restservices.Dialogs

Extends finesse.restservices.RestCollectionBase

Represents a collection of dialog objects.

Example

_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...
    }
}

For additional parameters and methods, see RestCollectionBase Common Parameters.

Field Details


Name	Description
REQUESTID_REAPER_TIMEOUT	Unique identifier of the request reaper timeout.

Method

getDialogCount(excludeSilentMonitor)

Retrieves the number of dialogs in the collection. The excludeSilentMonitor parameter is provided as an option to exclude dialogs with the call type of SUPERVISOR_MONITOR from the count.

Parameters


Name	Type	Description	Required
excludeSilentMonitor	Boolean	Determines whether the dialogs with the call type of SUPERVISOR_MONITOR is to be excluded from the count.	Yes

Returns

{Number} The number of dialogs in the collection.

For additional parameters and methods, see RestCollectionBase Common Parameters.