retry-progress-token-now.rst (1216B)
1 .. ts:op:: retryProgressTokenNow 2 3 Retry a long-running request now instead of waiting for its scheduled 4 retry delay. 5 6 **Request:** 7 8 The request ``args`` must be a `RetryProgressTokenNowRequest` object. 9 10 **Response:** 11 12 On success, the result is an empty object. 13 14 **Side effects:** 15 16 Abandons the remaining exponential-backoff delay of the pending 17 request; the request may restart immediately, causing network 18 activity. 19 20 **Details:** 21 22 Long-running operations accept an optional ``progressToken`` in their 23 request. While such a request keeps failing, wallet-core retries it 24 with exponential backoff and reports each failed attempt via a 25 ``request-progress-error`` notification, including the delay until the 26 next retry. This operation abandons the remaining delay, so that the 27 next attempt starts immediately. If the progress token is unknown or 28 the request has no retry logic, the operation has no effect. 29 30 .. ts:def:: RetryProgressTokenNowRequest 31 32 interface RetryProgressTokenNowRequest { 33 // Name of the operation that the progress token belongs to. 34 operation: string; 35 36 // Client-chosen progress token passed to the original request. 37 progressToken: string; 38 }