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

AsyncCallback

The callback interface used by asynchronous operations. An object with selected number of implemented callback functions shall be provided as argument when starting an asynchronous operation.

  • Methods

Method Summary

onCompleted ( operation )

The onCompleted() function is called when the asynchronous operation has completed. The final result (if any) will be available as the property result in 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 in 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 in the operation object.

onResult ( operation , result )

The onResult() function 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 (if any) will be available as the property result in 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 in 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 in the operation object.

Parameters:

Name Type Description
operation ToiAsynchronousOperation

The object representing the asynchronous operation.

onResult ( operation , result )

The onResult() function 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. Its property result contains the sum of all incremental results received so far.

result

The incremental result for the operation. The type of result depends on which asynchronous operation that is executing. For more information, see the documentation for the function that initiated the asynchronous operation.

5.1.p5

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