<protected> new RetrieveResultLocator(meta, result)
The locator class to track retreive() Metadata API call result
Parameters:
Name | Type | Description |
---|---|---|
meta |
Metadata | Metadata API object |
result |
Promise.<Metadata~AsyncResult> | Promise object for async result of retrieve call() |
- Source:
Extends
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 - Inherited From:
- 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 - Inherited From:
- 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 - Inherited From:
- Source:
-
stream() → {stream.Stream}
-
Change the retrieved result to Node.js readable stream
- Source:
Returns:
- Type
- stream.Stream
-
then()
-
Promise/A+ interface http://promises-aplus.github.io/promises-spec/ Delegate to deferred promise, return promise instance for batch result
- Inherited From:
- Source:
-
thenCall()
-
Promise/A+ extension Call "then" using given node-style callback function
- Inherited From:
- Source: