Constructor
-
new DataRetrieval(dataSet)
-
These API is internal to the SDK library and their use by third party applications could result in unpredictable behavior of the resulting application. No support will be provided by Avaya related to the use of any internal APIs.
Parameters:
Name Type Description dataSetAvayaClientServices.Base.DataSet
Members
-
isCancelled :boolean
-
Type:
- boolean
-
isCompleted :boolean
-
Type:
- boolean
Methods
-
cancel() → {void}
-
Cancels this data retrieval operation
Returns:
{ void }
-
getDataSet() → {AvayaClientServices.Base.DataSet}
-
Returns:
DataRetrieval callbacks
-
addOnDataRetrievalDoneCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalDone Returns:
{ void }
-
addOnDataRetrievalFailedCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalFailed Returns:
{ void }
-
addOnDataRetrievalProgressCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalProgress Returns:
{ void }
-
removeOnDataRetrievalDoneCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalDone Returns:
{ void }
-
removeOnDataRetrievalFailedCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalFailed Returns:
{ void }
-
removeOnDataRetrievalProgressCallback(callback) → {void}
-
Parameters:
Name Type Description callbackAvayaClientServices.Base.DataRetrieval#onDataRetrievalProgress Returns:
{ void }
Type Definitions
-
onDataRetrievalDone(allResultsRetrieved, total) → {void}
-
Interface for callback function to be invoked when the retrieval process is done.
Parameters:
Name Type Description allResultsRetrievedboolean | undefined a boolean indicating if all results for this data retrieval operation were retrieved. True for yes, false for no, undefined if we don't know.
totalnumber | undefined If allResultsRetrieved is true this will indicate the number of results retrieved otherwise it will be undefined.
Returns:
{ void }
-
onDataRetrievalFailed(error) → {void}
-
Interface for callback function to be invoked when the retrieval process is done.
Parameters:
Name Type Description errorAvayaClientServices.Base.BaseError Returns:
{ void }
-
onDataRetrievalProgress(retrievedCount, determinate, total) → {void}
-
Interface for callback function to be invoked on retrieval progress.
Parameters:
Name Type Argument Description retrievedCountnumber The number of elements that have been retrieved so far.
determinateboolean indicates if the total number of elements in the retrieval is known
totalnumber <optional>
The total number of elements. This will be undefined if determinate is false.
Returns:
{ void }