Collapse all Symbian^3 Application Developer Library

MNcdPurchaseDetails Class Reference

class MNcdPurchaseDetails

Purchase details.

Public Member Functions
	~MNcdPurchaseDetails ()
TInt32	AttributeInt32 ( TPurchaseAttribute )
const TDesC &	AttributeString ( TPurchaseAttribute )
const TDesC &	CatalogSourceName ()
TUid	ClientUid ()
const TDesC &	Description ()
const TDesC &	DownloadAccessPoint ()
TArray < MNcdPurchaseDownloadInfo * >	DownloadInfoL ()
const MDesCArray &	DownloadedFiles ()
const TDesC &	EntityId ()
const TDesC &	FinalPrice ()
TBool	HasIcon ()
const TDesC8 &	Icon ()
TArray < MNcdPurchaseInstallInfo * >	InstallInfoL ()
const TDesC &	ItemName ()
TUint	ItemPurpose ()
TItemType	ItemType ()
TInt	LastOperationErrorCode ()
TTime	LastOperationTime ()
const TDesC &	Namespace ()
const TDesC &	OriginNodeId ()
const TDesC &	PaymentMethodName ()
const TDesC &	PurchaseOptionId ()
const TDesC &	PurchaseOptionName ()
const TDesC &	PurchaseOptionPrice ()
TTime	PurchaseTime ()
const TDesC &	ServerUri ()
TState	State ()
TInt	TotalContentSize ()
const TDesC &	Version ()

Public Member Enumerations
enum	TItemType { EUnknown = 0, EItem = 1, EFolder = 2 }
enum	TPurchaseAttribute { EPurchaseAttributeContentUid = 0, EPurchaseAttributeContentMimeType , EPurchaseAttributeInternal }
enum	TState { EStatePurchased , EStateDownloaded , EStateInstalled }

Constructor & Destructor Documentation

~MNcdPurchaseDetails()

~MNcdPurchaseDetails

(

)

[inline, virtual]

Member Functions Documentation

AttributeInt32(TPurchaseAttribute)

TInt32

AttributeInt32

(

TPurchaseAttribute

aAttribute

)

const [pure virtual]

Integer attribute getter

panic: ENcdPanicIndexOutOfRange if aAttribute is invalid

panic: ENcdPanicInvalidArgument if the attribute type is not TInt32

Parameters

TPurchaseAttribute aAttribute

Attribute

AttributeString(TPurchaseAttribute)

const TDesC &

AttributeString

(

TPurchaseAttribute

aAttribute

)

const [pure virtual]

String attribute getter

panic: ENcdPanicIndexOutOfRange if aAttribute is invalid

panic: ENcdPanicInvalidArgument if the attribute type is not string

Parameters

TPurchaseAttribute aAttribute

Attribute

CatalogSourceName()

const TDesC &

CatalogSourceName

(

)

const [pure virtual]

Get catalog source name.

ClientUid()

TUid

ClientUid

(

)

const [pure virtual]

Get client UID.

Description()

const TDesC &

Description

(

)

const [pure virtual]

Get description.

DownloadAccessPoint()

const TDesC &

DownloadAccessPoint

(

)

const [pure virtual]

Get access point used in download process.

DownloadInfoL()

TArray < MNcdPurchaseDownloadInfo * >

DownloadInfoL

(

)

const [pure virtual]

Get download infos.

Note:

Only valid for purchases in EStatePurchased state.

DownloadedFiles()

const MDesCArray &

DownloadedFiles

(

)

const [pure virtual]

Get file name(s) of the downloaded file(s).

Note:

Only valid for purchases in EStateDownloaded state.

EntityId()

const TDesC &

EntityId

(

)

const [pure virtual]

Get entity ID.

FinalPrice()

const TDesC &

FinalPrice

(

)

const [pure virtual]

Get final price.

HasIcon()

TBool

HasIcon

(

)

const [pure virtual]

Checks whether this purchase detail has an icon.

Note:

This flag's intention is to indicate whether this purchase detail has an icon saved in the purhcase history. This does not indicate whether the actual icon data has been loaded or not.

Icon()

const TDesC8 &

Icon

(

)

const [pure virtual]

Get icon.

InstallInfoL()

TArray < MNcdPurchaseInstallInfo * >

InstallInfoL

(

)

const [pure virtual]

Get file installation infos.

Note:

Only valid for purchases in EStateInstalled state.

ItemName()

const TDesC &

ItemName

(

)

const [pure virtual]

Get item name.

ItemPurpose()

TUint

ItemPurpose

(

)

const [pure virtual]

Get item purpose.

TNcdItemPurpose

ItemType()

TItemType

ItemType

(

)

const [pure virtual]

Get item type.

LastOperationErrorCode()

TInt

LastOperationErrorCode

(

)

const [pure virtual]

Getter for the last operation error code that has been set by the NCD Engine during operations or by the user of the API.

Note:

The state gives the current state of the purchase details. If the error code is KErrNone, then the state of the purchase detail describes the state after a successfull operation. If the error code differs from KErrNone, then an error has occurred during an operation. The error code and the state can be used together to conclude what kind of operation failed. If the state is EStatePurchased after an error occurred, then there are two possibilities: either a purchase operation has failed or a download operation has failed. If the state is EStateDownloaded after an error occurred, then install operation has failed. If the state is EStateInstalled, then installing has succesfully completed and the error code should be KErrNone. If EStateInstalled is given with some other error code, this means that the installation was success but some repository information could not be set correctly.

LastOperationTime()

TTime

LastOperationTime

(

)

const [pure virtual]

Getter for the time of last operation that has been directed to the purchase item. The time is an universal time.

Namespace()

const TDesC &

Namespace

(

)

const [pure virtual]

Get namespace.

OriginNodeId()

const TDesC &

OriginNodeId

(

)

const [pure virtual]

Getter for origin node id.

PaymentMethodName()

const TDesC &

PaymentMethodName

(

)

const [pure virtual]

Get payment method name.

PurchaseOptionId()

const TDesC &

PurchaseOptionId

(

)

const [pure virtual]

Get purchase option ID.

PurchaseOptionName()

const TDesC &

PurchaseOptionName

(

)

const [pure virtual]

Get purchase option name.

PurchaseOptionPrice()

const TDesC &

PurchaseOptionPrice

(

)

const [pure virtual]

Get purchase option price.

PurchaseTime()

TTime

PurchaseTime

(

)

const [pure virtual]

Get time of purchase. The time is universal time, not local time.

ServerUri()

const TDesC &

ServerUri

(

)

const [pure virtual]

Get server URI.

State()

TState

State

(

)

const [pure virtual]

Get purchase state.

Note:

When an item has been installed, its state will remain as EStateInstalled in the purhcase detail even if the content was uninstalled.

TotalContentSize()

TInt

TotalContentSize

(

)

const [pure virtual]

Get the total size of the content of the item.

Version()

const TDesC &

Version

(

)

const [pure virtual]

Get version.

Member Enumerations Documentation

Enum TItemType

Type of the purchased item.

Enumerators

EUnknown = 0	Item has unknown type.
EItem = 1	This is item.
EFolder = 2	This is folder.

Enum TPurchaseAttribute

Additional attributes

These are retrieved with AttributeString and AttributeInt32

Adding new attributes does not cause a binary break but removing does

Enumerators

EPurchaseAttributeContentUid = 0

Content UID received in a protocol response

Type: Int32

EPurchaseAttributeContentMimeType

Content MIME type received in a protocol response

Type: String

EPurchaseAttributeInternal

Internal attribute value, DO NOT USE

Note:

Add new attributes before this

Enum TState

State of the purchase.

Enumerators

EStatePurchased	Payment made, but not downloaded nor installed.
EStateDownloaded	Payment made and content downloaded, but not installed.
EStateInstalled	Payment made, content downloaded and installed.