DataRetrievalWatcherT, E Class |
Namespace: Avaya.ClientServices
public class DataRetrievalWatcher<T, E> : IDisposable where E : EventArgs
The DataRetrievalWatcherT, E type exposes the following members.
Name | Description | |
---|---|---|
![]() | DataRetrievalWatcherT, E |
Creates a data retrieval watcher object for receiving events for data retrieval operations requested
by the client application.
|
Name | Description | |
---|---|---|
![]() | IsCancelled |
Returns true if the retrieval operation has been cancelled.
|
![]() | IsCompleted |
Returns true if the retrieval operation has completed successfully.
|
![]() | RequestId |
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.
|
Name | Description | |
---|---|---|
![]() | Cancel |
Cancels the data retrieval operation being watched by this object.
|
![]() | Dispose | Releases all resources used by the DataRetrievalWatcherT, E |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the DataRetrievalWatcherT, E and optionally releases the managed resources |
![]() | Finalize | (Overrides ObjectFinalize.) |
![]() | GetSnapshot |
Returns a snapshot of the objects in the collection being watched by this object.
|
Name | Description | |
---|---|---|
![]() | DataRetrievalCollectionChanged |
Indicates that the collection of data items associated with the data retrieval has changed.
|
![]() | DataRetrievalDone |
Indicates that data retrieval operation being watched by this object has completed.
|
![]() | DataRetrievalError |
Indicates that data retrieval operation being watched by this object has failed.
|
![]() | DataRetrievalProgress |
Provides updates on the progress of the data retrieval operation being watched by this object.
|
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.