update-exchange-entry.rst (1398B)
1 .. ts:op:: updateExchangeEntry 2 3 Update an exchange entry. 4 5 Only starts updating the exchange entry. After this request 6 finishes, it is not guaranteed that the exchange entry has been 7 updated. Use notifications and the :ts:op:`listExchanges` request 8 to check the status. 9 10 **Request:** 11 12 The request arguments must be an `UpdateExchangeEntryRequest` 13 object. 14 15 **Response:** 16 17 On success, the result is an empty object. 18 19 **Side effects:** 20 21 Starts an update of the exchange entry: data is fetched over the 22 network and notifications are emitted; completion is reported 23 asynchronously. 24 25 **Details:** 26 27 Setting ``force`` starts the update even when the entry was 28 recently updated or the exchange is currently marked unavailable. 29 30 If no exchange entry exists for ``exchangeBaseUrl`` yet, a new 31 entry is created and the update proceeds; the request does not 32 fail for unknown base URLs. Failures of the update itself (for 33 example the exchange being unreachable) are not reported as 34 request errors but asynchronously: they surface via notifications 35 and the ``lastUpdateErrorInfo`` of :ts:op:`listExchanges`. 36 37 .. ts:def:: UpdateExchangeEntryRequest 38 39 interface UpdateExchangeEntryRequest { 40 exchangeBaseUrl: string; 41 42 // Force the update even if the entry was recently updated or 43 // the exchange is currently marked unavailable. 44 force?: boolean; 45 }