Enumerations |
enum | AB_JOB_STATUS {
AB_Job_StatusNew = 0,
AB_Job_StatusUpdated,
AB_Job_StatusEnqueued,
AB_Job_StatusSent,
AB_Job_StatusPending,
AB_Job_StatusFinished,
AB_Job_StatusError,
AB_Job_StatusUnknown = 999
} |
enum | AB_JOB_TYPE {
AB_Job_TypeUnknown = 0,
AB_Job_TypeGetBalance,
AB_Job_TypeGetTransactions,
AB_Job_TypeTransfer,
AB_Job_TypeDebitNote,
AB_Job_TypeEuTransfer,
AB_Job_TypeGetStandingOrders,
AB_Job_TypeGetDatedTransfers,
AB_Job_TypeCreateStandingOrder,
AB_Job_TypeModifyStandingOrder,
AB_Job_TypeDeleteStandingOrder,
AB_Job_TypeCreateDatedTransfer,
AB_Job_TypeModifyDatedTransfer,
AB_Job_TypeDeleteDatedTransfer,
AB_Job_TypeInternalTransfer,
AB_Job_TypeLoadCellPhone,
AB_Job_TypeSepaTransfer,
AB_Job_TypeSepaDebitNote
} |
Logging Functions |
AqBanking logs every activity on a job. These logs can be usefull when something went wrong. If a job performs without problems most of the logs are removed from the job because otherwise the jobs would fill up your disk space.
|
void | AB_Job_Log (AB_JOB *j, GWEN_LOGGER_LEVEL ll, const char *who, const char *txt) |
GWEN_STRINGLIST * | AB_Job_GetLogs (const AB_JOB *j) |
Detailed Description
This group represents online banking tasks such as retrieving the balance, downloading transaction statements, issue transfers etc.
Typedef Documentation
Enumeration Type Documentation
The status of a job.
- Enumerator:
AB_Job_StatusNew |
Job is new and not yet enqueued.
|
AB_Job_StatusUpdated |
job has been updated by the backend and is still not yet enqueued.
|
AB_Job_StatusEnqueued |
Job has been enqueued, i.e. it has not yet been sent, but will be sent at the next AB_BANKING_ExecuteQueue(). These jobs are stored in the "todo" directory.
|
AB_Job_StatusSent |
Job has been sent, but there is not yet any response.
|
AB_Job_StatusPending |
Job has been sent, and an answer has been received, so the Job has been successfully sent to the bank. However, the answer to this job said that the job is still pending at the bank server. This status is most likely used with transfer orders which are accepted by the bank server but checked (and possibly rejected) later. These jobs are stored in the "pending" directory.
|
AB_Job_StatusFinished |
Job has been sent, a response has been received, and everything has been sucessfully executed. These jobs are stored in the "finished" directory.
|
AB_Job_StatusError |
There was an error in jobs' execution. These jobs are stored in the "finished" directory. Jobs are never enqueued twice for execution, so if it has this status it will never be sent again.
|
AB_Job_StatusUnknown |
Unknown status
|
Definition at line 120 of file job.h.
The type of the job, which also corresponds to its subclass of AB_JOB.
- Enumerator:
AB_Job_TypeUnknown |
unknown job
|
AB_Job_TypeGetBalance |
retrieve the balance of an online account
|
AB_Job_TypeGetTransactions |
retrieve transaction statements for an online account
|
AB_Job_TypeTransfer |
issue a transfer
|
AB_Job_TypeDebitNote |
issue a debit note (Lastschrift)
|
AB_Job_TypeEuTransfer |
EU transfer (transfer within the EMU zone)
|
AB_Job_TypeGetStandingOrders |
retrieve list of standing orders for an online account
|
AB_Job_TypeGetDatedTransfers |
retrieve list of dated transfers for an online account
|
AB_Job_TypeCreateStandingOrder |
creates a new standing order
|
AB_Job_TypeModifyStandingOrder |
modifies an existing standing order
|
AB_Job_TypeDeleteStandingOrder |
deletes an existing standing order
|
AB_Job_TypeCreateDatedTransfer |
creates a new dated transfer
|
AB_Job_TypeModifyDatedTransfer |
modifies an existing dated transfer
|
AB_Job_TypeDeleteDatedTransfer |
deletes an existing dated transfer
|
AB_Job_TypeInternalTransfer |
|
AB_Job_TypeLoadCellPhone |
Load a prepaid card from a bank account
|
AB_Job_TypeSepaTransfer |
SEPA transfer
|
AB_Job_TypeSepaDebitNote |
SEPA debit note
|
Definition at line 153 of file job.h.
Function Documentation
void AB_Job_Attach |
( |
AB_JOB * |
j | ) |
|
Transforms the given string into a job status code.
Transforms the given string into a job type.
int AB_Job_CheckAvailability |
( |
AB_JOB * |
j | ) |
|
Not all jobs have to be supported by every backend. The application needs to know whether a job actually is supported, and this is done by calling this function. It returns the error code (see Error Codes) returned by the backend when asked to check for this job.
GWEN_TIME* AB_Job_DateFromDb |
( |
GWEN_DB_NODE * |
db, |
|
|
const char * |
name |
|
) |
| |
GWEN_TIME* AB_Job_DateOnlyFromDb |
( |
GWEN_DB_NODE * |
db, |
|
|
const char * |
name |
|
) |
| |
void AB_Job_DateOnlyToDb |
( |
const GWEN_TIME * |
ti, |
|
|
GWEN_DB_NODE * |
db, |
|
|
const char * |
name |
|
) |
| |
void AB_Job_DateToDb |
( |
const GWEN_TIME * |
ti, |
|
|
GWEN_DB_NODE * |
db, |
|
|
const char * |
name |
|
) |
| |
void AB_Job_free |
( |
AB_JOB * |
j | ) |
|
Every job is linked to a single account to operate on.
GWEN_DB_NODE* AB_Job_GetAppData |
( |
AB_JOB * |
j | ) |
|
Returns a GWEN_DB_NODE which can be used to store/retrieve data for the currently running application. The group returned MUST NOT be freed ! AqBanking is able to separate and store the data for every application.
const char* AB_Job_GetCreatedBy |
( |
const AB_JOB * |
j | ) |
|
Returns the name of the application which created this job.
uint32_t AB_Job_GetJobId |
( |
const AB_JOB * |
j | ) |
|
Every created job gets an unique id. This allows any application to identify a specific job. However, unique ids are assigned when they get enqueued (i.e. by calling AB_Banking_EnqueueJob).
const GWEN_TIME* AB_Job_GetLastStatusChange |
( |
const AB_JOB * |
j | ) |
|
Returns the time when the status of this job changed last.
GWEN_STRINGLIST* AB_Job_GetLogs |
( |
const AB_JOB * |
j | ) |
|
Returns a string list containing the logs of the job. Each entry of that string list contains the date/time, loglevel, source and text. The caller becomes the owner of the returned object (if any), please call GWEN_StringList_free on it to avoid memory leaks.
const char* AB_Job_GetResultText |
( |
const AB_JOB * |
j | ) |
|
Returns a text result provided by the backend upon execution of this job. This should only be presented to the user when there is no other way to determine the result (e.g. no log etc).
Returns the status of this job.
const char* AB_Job_GetUsedTan |
( |
const AB_JOB * |
j | ) |
|
This function frees all jobs contained in the given list but does not destroy the list itself
This function frees all jobs contained in the given list and the list itself.
void AB_Job_Log |
( |
AB_JOB * |
j, |
|
|
GWEN_LOGGER_LEVEL |
ll, |
|
|
const char * |
who, |
|
|
const char * |
txt |
|
) |
| |
Transforms the given status code into a string.
Transforms the given job type into a string.
Transforms the given job type into a localized string which can be presented to the user.