Click or drag to resize

DataRetrievalWatcherT, E Class

This class defines an interface that client applications use to perform data retrieval operations for both static and dynamic collections of objects within the SDK.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesDataRetrievalWatcherT, E
    More...

Namespace:  Avaya.ClientServices
Assembly:  AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
public class DataRetrievalWatcher<T, E> : IDisposable
where E : EventArgs

Type Parameters

T
The type of objects in the retrieved collection.
E
The type of error object delivered in the DataRetrievalError event.

The DataRetrievalWatcherT, E type exposes the following members.

Constructors
  NameDescription
Public methodDataRetrievalWatcherT, E
Creates a data retrieval watcher object for receiving events for data retrieval operations requested by the client application.
Top
Properties
  NameDescription
Public propertyIsCancelled
Returns true if the retrieval operation has been cancelled.
Public propertyIsCompleted
Returns true if the retrieval operation has completed successfully.
Public propertyRequestId
The unique request ID associated with this data retrieval. If the request has not been initiated or is not outstanding, the value will be 0.
Top
Methods
  NameDescription
Public methodCancel
Cancels the data retrieval operation being watched by this object.
Public methodDispose
Releases all resources used by the DataRetrievalWatcherT, E
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the DataRetrievalWatcherT, E and optionally releases the managed resources
Protected methodFinalize (Overrides ObjectFinalize.)
Public methodGetSnapshot
Returns a snapshot of the objects in the collection being watched by this object.
Top
Events
  NameDescription
Public eventDataRetrievalCollectionChanged
Indicates that the collection of data items associated with the data retrieval has changed.
Public eventDataRetrievalDone
Indicates that data retrieval operation being watched by this object has completed.
Public eventDataRetrievalError
Indicates that data retrieval operation being watched by this object has failed.
Public eventDataRetrievalProgress
Provides updates on the progress of the data retrieval operation being watched by this object.
Top
Remarks
An instance of this "watcher" class is created by the client application for use in methods that initiate some form of data retrieval operation that runs asynchronously and updates a collection of objects of type "T". It can be used in cases where a static collection of objects is being retrieved (e.g. search results, etc) or for dynamically updated collections that are retrieved and then subsequently updated as events occur within the system (e.g. the active participants in a conference call).

Following creation of a DataRetrievalWatcher object, and before the object is used in a method call, the application should install event handlers on any of the events it is interested in. This allows the event handlers to be wired up prior to initiating the action that will perform the data retrieval.

For static collections, the DataRetrievalCollectionChanged event will fire as objects are added to the collection during the retrieval. Once the static collection has been completely retrieved, the DataRetrievalDone event will fire indicating that the retrieval is complete. Following this, no additional events will be signalled.

For dynamic collections, the DataRetrievalCollectionChanged event will fire as objects are added to the collection during the initial retrieval. It will also fire whenever any of the objects already in the collection are changed or removed. Once the initial retrieval of the dynamic collection has been completed, the DataRetrievalDone event will fire indicating that the initial retrieval is complete. Following this, the DataRetrievalCollectionChanged event will fire whenever any changes to the collection occur.

See Also
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesDataRetrievalWatcherT, E
    Avaya.ClientServicesAddressValidationWatcher
    Avaya.ClientServicesConferenceMobileLinkDiscoveryWatcher
    Avaya.ClientServicesContactGroupRetrievalWatcher
    Avaya.ClientServicesContactRetrievalWatcher
    Avaya.ClientServicesConversationRetrievalWatcher
    Avaya.ClientServicesLeaveConversationsWatcher
    Avaya.ClientServicesMessageRetrievalWatcher
    Avaya.ClientServicesSearchContactsWatcher
    Avaya.ClientServicesSearchConversationsWatcher
    Avaya.ClientServicesSearchTerminalsWatcher
    Avaya.ClientServices.SpacesSpacesRetrievalWatcher
    Avaya.ClientServicesVisualVoiceMailRetrievalWatcher