<protected> new AsyncResultLocator(meta, results, isArray)
The locator class for Metadata API asynchronous call result
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
meta |
Metadata | Metadata API object | |
results |
Promise.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)> | Promise object for async result info | |
isArray |
Boolean |
<optional> |
Indicates whether the async request is given in array or single object |
- Source:
Extends
- events.EventEmitter
Methods
-
check(callback) → {Promise.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)>}
-
Check the status of async request
Parameters:
Name Type Argument Description callback
Callback.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)> <optional>
Callback function - Source:
Returns:
- Type
- Promise.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)>
-
complete(callback) → {Promise.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)>}
-
Check and wait until the async requests become in completed status
Parameters:
Name Type Argument Description callback
Callback.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)> <optional>
Callback function - Source:
Returns:
- Type
- Promise.<(Metadata~AsyncResult|Array.<Metadata~AsyncResult>)>
-
poll(interval, timeout)
-
Polling until async call status becomes complete or error
Parameters:
Name Type Description interval
Number Polling interval in milliseconds timeout
Number Polling timeout in milliseconds - Source:
-
then()
-
Promise/A+ interface http://promises-aplus.github.io/promises-spec/ Delegate to deferred promise, return promise instance for batch result
- Source:
-
thenCall()
-
Promise/A+ extension Call "then" using given node-style callback function
- Source: