taler-docs

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

get-active-tasks.rst (962B)


      1 .. ts:op:: getActiveTasks
      2   :read-only:
      3 
      4   Get the wallet's currently active background tasks and their retry
      5   state.
      6 
      7   **Request:**
      8 
      9     This operation takes no arguments (an empty object).
     10 
     11   **Response:**
     12 
     13     On success, the result is a `GetActiveTasksResponse` object.
     14 
     15   **Details:**
     16 
     17     Tasks are wallet-core's background retry loops, for example for
     18     pending withdrawals or payments.  ``firstTry`` and ``nextTry``
     19     give the time of the first attempt and of the next scheduled
     20     retry; ``lastError`` is the error of the most recent attempt, if
     21     any.
     22 
     23 .. ts:def:: GetActiveTasksResponse
     24 
     25   interface GetActiveTasksResponse {
     26     tasks: ActiveTask[];
     27   }
     28 
     29 .. ts:def:: ActiveTask
     30 
     31   interface ActiveTask {
     32     taskId: string;
     33     transaction?: TransactionIdStr | undefined;
     34     firstTry?: AbsoluteTime | undefined;
     35     nextTry?: AbsoluteTime | undefined;
     36     retryCounter?: number | undefined;
     37     lastError?: TalerErrorDetail | undefined;
     38   }