taler-docs

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

testing-wait-balance.rst (645B)

      1 .. ts:op:: testingWaitBalance
      2   :read-only:
      3 
      4   Wait until a balance has reached the desired value.  Waits until the
      5   material balance in the currency of ``amount`` equals ``amount``;
      6   only ``type`` ``"material"`` is currently supported.  The operation
      7   blocks until this condition is met or the wait fails, for example
      8   when the request is cancelled.
      9 
     10   **Request:**
     11 
     12     The request must be a `TestingWaitBalanceRequest` object.
     13 
     14   **Response:**
     15 
     16     On success, the result is an empty object.
     17 
     18 .. ts:def:: TestingWaitBalanceRequest
     19 
     20   interface TestingWaitBalanceRequest {
     21     type: "material" | "available";
     22     amount: AmountString;
     23   }