taler-docs

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

testing-wait-exchange-ready.rst (859B)

      1 .. ts:op:: testingWaitExchangeReady
      2 
      3   Wait until an exchange entry is ready.  Returns an error if updating
      4   the exchange failed.
      5 
      6   **Request:**
      7 
      8     The request must be a `TestingWaitExchangeReadyRequest` object.
      9 
     10   **Response:**
     11 
     12     On success, the result is an empty object.
     13 
     14   **Side effects:**
     15 
     16     May trigger an update of the exchange entry over the network, for
     17     example when ``forceUpdate`` is set.
     18 
     19 .. ts:def:: TestingWaitExchangeReadyRequest
     20 
     21   interface TestingWaitExchangeReadyRequest {
     22     exchangeBaseUrl: string;
     23 
     24     // Do not stop waiting even when the exchange is
     25     // in an error state.
     26     noBail?: boolean;
     27 
     28     // Force waiting until an update really happened.
     29     forceUpdate?: boolean;
     30 
     31     // Only consider the exchange as ready if the
     32     // next auto-refresh is scheduled for the future.
     33     waitAutoRefresh?: boolean;
     34   }