taler-docs

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

dismiss-wallet-warning.rst (1119B)


      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. Observers
     17   of the affected scope receive the updated report.
     18 
     19   **Details:**
     20 
     21   When wallet-core automatically refreshed coins that were close to
     22   expiration, the renewal is reported as a `CashRenewalNotice` in the
     23   ``recoveries`` of the scoped `WalletRefreshInfo` report.  Passing
     24   the notice's ``warningId`` to this operation dismisses the notice, so
     25   that it is no longer reported.  Renewal notices of refresh operations
     26   that are still active, as well as unknown warning identifiers, are
     27   ignored; the operation still succeeds.
     28 
     29 .. ts:def:: DismissWalletWarningRequest
     30 
     31   interface DismissWalletWarningRequest {
     32     // Identifier of the wallet warning to dismiss, as found in the
     33     // warningId field of a CashRenewalNotice.
     34     warningId: string;
     35   }