MNcdPurchaseHistory Class Reference

class MNcdPurchaseHistory : public MCatalogsBase

Purchase history interface.

This interface gives access to the purchase history. Purchase details can be inserted into the purchase history and list of previously inserted details can be asked through this interface.

Inherits from

Constructor & Destructor Documentation

~MNcdPurchaseHistory()

~MNcdPurchaseHistory ( ) [protected, inline, virtual]

Member Functions Documentation

EventCountL()

TUint EventCountL ( ) [pure virtual]

Get count of all purchase events.

PurchaseDetailsL(TUint, TBool)

CNcdPurchaseDetails * PurchaseDetailsL ( TUint aPurchaseId,
TBool aLoadIcon = ETrue
) [pure virtual]

Get purchase details from purchase history.

Exceptions
KErrNotFound

if purchase is not found.

Parameters

TUint aPurchaseId ID of the purchase. PurchaseIdsL function can be used to get purchase IDs.
TBool aLoadIcon = ETrue If EFalse, icon is not loaded from the purchase history. ETrue by default.

PurchaseIdsL(const MNcdPurchaseHistoryFilter &)

RArray < TUint > PurchaseIdsL ( const MNcdPurchaseHistoryFilter & aFilter ) [pure virtual]

Get purchase IDs from purchase history.

Exceptions
Leave

System wide error code.

Parameters

const MNcdPurchaseHistoryFilter & aFilter Filter used to get certain purchase IDs from the purchase history.

RemovePurchaseL(TUint)

void RemovePurchaseL ( TUint aPurchaseId ) [pure virtual]

Remove purchase from purchase history.

Exceptions
KErrNotFound

if purchase is not found.

Parameters

TUint aPurchaseId ID of the purchase. PurchaseIdsL function can be used to get purchase IDs.

SavePurchaseL(const MNcdPurchaseDetails &, TBool)

void SavePurchaseL ( const MNcdPurchaseDetails & aDetails,
TBool aSaveIcon = ETrue
) [pure virtual]

Save purchase into the purchase history. Purchase details of previous purchase will be overwritten, if Namespace, Entity ID, purchase time and client UID of new details matches to the previous details.

Parameters

const MNcdPurchaseDetails & aDetails Details of the purchase.
TBool aSaveIcon = ETrue ETrue by default, which means that a purchase detail icon is also saved with other purchase details. If EFalse, a new icon will not be saved into the purchase history. This is useful, for example, if an icon was not loaded when PurchaseDetailsL function was used and the old icon should be left into the purchase history when purchase details are saved.