taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

cancel-progress-token.rst (727B)

      1 .. ts:op:: cancelProgressToken
      2 
      3   Cancel the running request associated with a progress token.
      4 
      5   **Request:**
      6 
      7   The request ``args`` must be a `CancelProgressTokenRequest` object.
      8 
      9   **Response:**
     10 
     11   On success, the result is an empty object.
     12 
     13   **Side effects:**
     14 
     15   Aborts the in-flight request; the request then fails with error code
     16   ``WALLET_CORE_REQUEST_CANCELLED``.
     17 
     18   **Details:**
     19 
     20   If the progress token is unknown, the operation has no effect.
     21 
     22 .. ts:def:: CancelProgressTokenRequest
     23 
     24   interface CancelProgressTokenRequest {
     25     // Name of the operation that the progress token belongs to.
     26     operation: string;
     27 
     28     // Client-chosen progress token passed to the original request.
     29     progressToken: string;
     30   }