• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

AsyncCallback

Callbacks for the asynchronous operations. It acts as the input param of the asynchronous function caller.

  • Methods

Method Summary

onCompleted ( operation )

The onCompleted function is called when the asynchronous operation has completed. The final result will be available as the property result on the operation object

onError ( operation )

The onError function is called if the asynchronous operation has failed. The error code will be available as the property errorCode on the operation object.

onProgress ( operation )

The onProgress function is called to indicate that the asynchronous operation has progressed. The progress (in percent) is available as the property progress on the operation object.

onResult ( operation , result )

The onResult is called when there is a new or updated result from the asynchronous operation.

Methods

onCompleted ( operation )

The onCompleted function is called when the asynchronous operation has completed. The final result will be available as the property result on the operation object

Parameters:

Name Type Description
operation ToiAsynchronousOperation

The object representing the asynchronous operation.

onError ( operation )

The onError function is called if the asynchronous operation has failed. The error code will be available as the property errorCode on the operation object.

Parameters:

Name Type Description
operation ToiAsynchronousOperation

The object representing the asynchronous operation.

onProgress ( operation )

The onProgress function is called to indicate that the asynchronous operation has progressed. The progress (in percent) is available as the property progress on the operation object.

Parameters:

Name Type Description
operation ToiAsynchronousOperation

The object representing the asynchronous operation.

onResult ( operation , result )

The onResult is called when there is a new or updated result from the asynchronous operation.

Parameters:

Name Type Description
operation ToiAsynchronousOperation

The object representing the asynchronous operation.

result

The incremental result for the operation. The type of result depends on which asynchronous operation has completed. See the documentation for the function where the callbacks were registered for more information.

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.