Avaya Client Services API Reference (OS X)
Instance Methods | List of all members
<CSDataRetrievalDelegate> Protocol Reference

Deprecated: Replaced by CSDataRetrievalWatcherDelegate. More...

#import <CSDataRetrieval.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - dataRetrieval:didUpdateProgress:retrievedCount:totalCount:
 Called to report progress in loading elements into the data set. More...
 
(void) - dataRetrievalDidComplete:
 Called when the data retrieval operation has completed. More...
 
(void) - dataRetrieval:didFailWithError:
 Called when the data retrieval operation has failed. More...
 

Detailed Description

Deprecated: Replaced by CSDataRetrievalWatcherDelegate.

Method Documentation

- (void) dataRetrieval: (CSDataRetrieval *)  dataRetrieval
didFailWithError: (NSError *)  error 

Called when the data retrieval operation has failed.

If this is called, there will be no further updates to the data retrieval and data set. Any existing data in the data set that was already received is still accessible and might still be of use.

Parameters
dataRetrievalThe data retrieval operation that failed.
errorObject containing information about the failure.
- (void) dataRetrieval: (CSDataRetrieval *)  dataRetrieval
didUpdateProgress: (BOOL)  determinate
retrievedCount: (NSUInteger)  retrievedCount
totalCount: (NSUInteger)  totalCount 

Called to report progress in loading elements into the data set.

This is called after new elements have been added to the data set.

Parameters
dataRetrievalThe data retrieval operation in progress.
determinateIf 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 it runs out of data.
retrievedCountThe number of elements that has been retrieved so far.
totalCountThe total number of elements. This can only be relied upon when determinate is YES.
- (void) dataRetrievalDidComplete: (CSDataRetrieval *)  dataRetrieval

Called when the data retrieval operation has completed.

Parameters
dataRetrievalThe data retrieval operation that completed.

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