ChipDna Mobile
Loading...
Searching...
No Matches
Instance Methods | Class Methods | List of all members
SOAPTransactionHistory Class Reference

This class should be used to access the transaction history and statistics. More...

#import <SOAPTransactionHistory.h>

Inherits NSObject.

Instance Methods

(void) - getTransactionsFromDate:toDate:delegate:
 
(void) - getTransactionTransactionDate:withGuid:delegate:
 
(void) - getTransactionsStatisticsFromDate:toDate:delegate:
 

Class Methods

(SOAPTransactionHistory *) + sharedInstance
 
(void) + dispose
 

Detailed Description

This class should be used to access the transaction history and statistics.

Author
Creditcall Ltd

The first time that the method is invoked on the SOAPTransactionHistory instance, the login will be carried out, as such, the first call might take slightly longer then successive calls. The login will expire after 15 minutes and if another method is invoked on instance 15 minutes after the last method, the login will be carried out again.

Method Documentation

◆ dispose

+ (void) dispose

Disposes of the current instance. If a new instance is retrieved after calling this method, the user will have to be logged in again.

This method is also called internally when ChipDnaMobileProperties::save: is invoked, if application mode or SOAP credentials were changed. It ensures that the instance uses the right credentials. It means that a new copy of SOAPTransactionHistory instance should be retrieved after changing the ChipDnaMobileProperties.

◆ getTransactionsFromDate:toDate:delegate:

- (void) getTransactionsFromDate: (NSString *)  fromDate
toDate: (NSString *)  toDate
delegate: (id< SOAPDelegate >)  delegate 

Retrieves the transactions between the given dates. Once the result is retrieved, SOAPDelegate::retrievedTransactions:error: will be invoked.

Parameters
fromDatethe date from which the transactions should be retrieved, in UTC, in "dd/MM/yyyy HH:mm:ss" format.
toDatethe date to which the transactions should be retrieved, in UTC, in "dd/MM/yyyy HH:mm:ss" format.
delegateThe delegate to be notified when the result of the query has been retrieved.

◆ getTransactionsStatisticsFromDate:toDate:delegate:

- (void) getTransactionsStatisticsFromDate: (NSString *)  fromDate
toDate: (NSString *)  toDate
delegate: (id< SOAPDelegate >)  delegate 

Retrieves the transaction statistics between the given dates. Once the result is retrieved, SOAPDelegate::retrievedTransactionStatistics:error: will be invoked.

Parameters
fromDatethe date from which the transaction statistics should be retrieved, in UTC, in "dd/MM/yyyy HH:mm:ss" format.
toDatethe date to which the transaction statistics should be retrieved, in UTC, in "dd/MM/yyyy HH:mm:ss" format.
delegateThe delegate to be notified when the result of the query has been retrieved.

◆ getTransactionTransactionDate:withGuid:delegate:

- (void) getTransactionTransactionDate: (NSString *)  transactionDate
withGuid: (NSString *)  guid
delegate: (id< SOAPDelegate >)  delegate 

Retrieves the transaction with specified date and GUID. Once the result is retrieved, SOAPDelegate::retrievedTransaction:error: will be invoked.

Parameters
transactionDateThe date of the transaction, in UTC, in "dd/MM/yyyy HH:mm:ss" format.
guidGUID (CardEase reference) of the transaction.
delegateThe delegate to be notified when the result of the query has been retrieved.

◆ sharedInstance

+ (SOAPTransactionHistory *) sharedInstance

Returns an instance of SOAPTransactionHistory. This method should only be called after ChipDnaMobile has been initialised using ChipDnaMobile::initialise:applicationIdentifier:. ChipDnaMobile::isInitialised can be used to check whether ChipDnaMobile has been initialised already.

Transaction history must be supported and set-up, otherwise an exception will be raised. This can be checked using ChipDnaMobileProperties::isTransactionHistorySupported and ChipDnaMobileProperties::isTransactionHistorySetUp methods.

Returns
an instance of SOAPTransactionHistory.
Exceptions
CCInitialisationExceptionThrown if the method is accessed before ChipDnaMobile has been initialised.

The documentation for this class was generated from the following file: