Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSDataRetrievalWatcherDelegate> Protocol Reference

This protocol is used by CSDataRetrievalWatcher objects to report progress for the retrieval operation and updates to the associated data collection. More...

`#import <CSDataRetrievalWatcher.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - dataRetrievalWatcher:didUpdateProgress:retrievedCount:totalCount:
| Sent to report progress in loading elements into the data collection. More...
(void) | - dataRetrievalWatcherDidComplete:
| Sent to report successful completion of the data retrieval operation. More...
(void) | - dataRetrievalWatcher:didFailWithError:
| Sent to report that the data retrieval operation has failed. More...
(void) | - dataRetrievalWatcher:contentsDidChange:changedItems:
| Sent whenever the underlying data collection has changed. More...

## Detailed Description

This protocol is used by CSDataRetrievalWatcher objects to report progress for the retrieval operation and updates to the associated data collection.

## Method Documentation

- (void) dataRetrievalWatcher: |  | (CSDataRetrievalWatcher *) | dataRetrievalWatcher
contentsDidChange: |  | (CSDataCollectionChangeType) | changeType
changedItems: |  | (NSArray *) | changedItems
| optional

Sent whenever the underlying data collection has changed.

Parameters

  dataRetrievalWatcher | The data retrieval watcher whose contents have changed.
  changeType | The type of change that has occurred on the data collection.
  changedItems | An array of data items that have changed. For a delete change, the supplied data items have been removed from the data collection. For a "collection cleared" change, this array will be empty.

- (void) dataRetrievalWatcher: |  | (CSDataRetrievalWatcher *) | dataRetrievalWatcher
didFailWithError: |  | (NSError *) | error
| optional

Sent to report that the data retrieval operation has failed.

After this message is sent, there will be no further updates to the data retrieval and data collection. Any existing data in the data collection that was already received is still accessible and might still be of use.

Parameters

  dataRetrievalWatcher | The data retrieval watcher whose retrieval operation has failed.
  error | An error object containing information about the failure.

- (void) dataRetrievalWatcher: |  | (CSDataRetrievalWatcher *) | dataRetrievalWatcher
didUpdateProgress: |  | (BOOL) | determinate
retrievedCount: |  | (NSUInteger) | retrievedCount
totalCount: |  | (NSUInteger) | totalCount
| optional

Sent to report progress in loading elements into the data collection.

This message is sent as new elements are added to the data collection and is useful for updating any progress indicator that may be associated with the data retrieval operation.

Parameters

  dataRetrievalWatcher | The data retrieval watcher object sending the message.
  determinate | If `YES`, the total number of elements to be loaded is known in advance. If `NO`, the total number of elements is not known, and the retrieval will continue until all elements have been loaded.
  retrievedCount | The number of elements that have been retrieved so far.
  totalCount | The total number of elements being retrieved. This can only be relied upon when the determinate parameter is `YES`. When the determinate parameter is `NO`, this will be zero.

See also
  - dataRetrievalWatcher:contentsDidChange:changedItems:

- (void) dataRetrievalWatcherDidComplete: |  | (CSDataRetrievalWatcher *) | dataRetrievalWatcher |
| optional

Sent to report successful completion of the data retrieval operation.

Parameters

  dataRetrievalWatcher | The data retrieval watcher whose retrieval operation has completed.

The documentation for this protocol was generated from the following file:

- CSDataRetrievalWatcher.h