taler-docs

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

dismiss-wallet-warning.rst (1148B)

      1 .. ts:op:: dismissWalletWarning
      2 
      3   Dismiss a completed renewal notice.  Active expiration risks cannot be
      4   dismissed.
      5 
      6   **Request:**
      7 
      8   The request ``args`` must be a `DismissWalletWarningRequest` object.
      9 
     10   **Response:**
     11 
     12   On success, the result is an empty object.
     13 
     14   **Side effects:**
     15 
     16   Persistently marks a completed renewal notice as dismissed; when a
     17   notice was actually dismissed, a ``balance-change`` notification is
     18   emitted.
     19 
     20   **Details:**
     21 
     22   When wallet-core automatically refreshed coins that were close to
     23   expiration, the renewal is reported as a `CashRenewalNotice` in the
     24   ``refreshInfo.recoveries`` of the affected `WalletBalance`.  Passing
     25   the notice's ``warningId`` to this operation dismisses the notice, so
     26   that it is no longer reported.  Renewal notices of refresh operations
     27   that are still active, as well as unknown warning identifiers, are
     28   ignored; the operation still succeeds.
     29 
     30 .. ts:def:: DismissWalletWarningRequest
     31 
     32   interface DismissWalletWarningRequest {
     33     // Identifier of the wallet warning to dismiss, as found in the
     34     // warningId field of a CashRenewalNotice.
     35     warningId: string;
     36   }