taler-docs

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

force-refresh.rst (963B)

      1 .. ts:op:: forceRefresh
      2 
      3   Force a refresh on coins where it would not be necessary.  Creates a
      4   manual refresh group for the given coins.
      5 
      6   **Request:**
      7 
      8     The request must be a `ForceRefreshRequest` object.
      9 
     10   **Response:**
     11 
     12     On success, the result is an empty object.
     13 
     14   **Side effects:**
     15 
     16     Refreshes the given coins at the exchange over the network even
     17     where a refresh would not be necessary; creates refresh
     18     transactions.
     19 
     20   **Details:**
     21 
     22     The request fails if ``refreshCoinSpecs`` is empty or names a coin
     23     that is unknown to the wallet.  Each coin is refreshed for its full
     24     denomination value, unless a smaller ``amount`` is given.
     25 
     26 .. ts:def:: ForceRefreshRequest
     27 
     28   interface ForceRefreshRequest {
     29     refreshCoinSpecs: RefreshCoinSpec[];
     30   }
     31 
     32 .. ts:def:: RefreshCoinSpec
     33 
     34   interface RefreshCoinSpec {
     35     coinPub: string;
     36 
     37     // Amount to refresh; defaults to the coin's denomination value.
     38     amount?: AmountString;
     39   }