- updateExchangeEntry#
Update an exchange entry.
Only starts updating the exchange entry. After this request finishes, it is not guaranteed that the exchange entry has been updated. Use notifications and the listExchanges request to check the status.
Request:
The request arguments must be an UpdateExchangeEntryRequest object.
Response:
On success, the result is an empty object.
Side effects:
Starts an update of the exchange entry: data is fetched over the network and notifications are emitted; completion is reported asynchronously.
Details:
Setting
forcestarts the update even when the entry was recently updated or the exchange is currently marked unavailable.If no exchange entry exists for
exchangeBaseUrlyet, a new entry is created and the update proceeds; the request does not fail for unknown base URLs. Failures of the update itself (for example the exchange being unreachable) are not reported as request errors but asynchronously: they surface via notifications and thelastUpdateErrorInfoof listExchanges.
interface UpdateExchangeEntryRequest {
exchangeBaseUrl: string;
// Force the update even if the entry was recently updated or
// the exchange is currently marked unavailable.
force?: boolean;
}