Collapse all Symbian^3 Application Developer Library

MNcdNodeMetadata Class Reference

class MNcdNodeMetadata : public MCatalogsBase

Node metadata contains the basic information about the content. Mainly this interface provides functions that can be used to show various information about the node in the UI.

This interface can be queried from a node object after its metadata has been downloaded to the terminal. Metadata can be downloaded by calling the node object's MNcdNode::LoadL() method.

Inherits from

MNcdNodeMetadata
- MCatalogsBase

Public Member Functions
const TDesC &	ActionName ()
const TDesC &	Description ()
const RPointerArray < CNcdKeyValuePair > &	Details ()
MNcdQuery *	Disclaimer ()
const TDesC &	Id ()
TBool	IsAlwaysVisible ()
const TDesC &	LayoutType ()
MNcdQuery *	MoreInfo ()
const TDesC &	Name ()
const TDesC &	Namespace ()

Protected Member Functions
	~MNcdNodeMetadata ()

Inherited Functions
	MCatalogsBase::AddRef()const
	MCatalogsBase::QueryInterfaceL()
	MCatalogsBase::QueryInterfaceL()const
	MCatalogsBase::QueryInterfaceL(TInt)const
	MCatalogsBase::QueryInterfaceLC()
	MCatalogsBase::QueryInterfaceLC()const
	MCatalogsBase::Release()const
	MCatalogsBase::~MCatalogsBase()

Inherited Enumerations
	MCatalogsBase:@52

Constructor & Destructor Documentation

~MNcdNodeMetadata()

~MNcdNodeMetadata

(

)

[protected, inline, virtual]

Destructor.

MCatalogsBase::~MCatalogsBase

Member Functions Documentation

ActionName()

const TDesC &

ActionName

(

)

const [pure virtual]

Gets the action name for the item.

For example, the action for an item could be "Open", "Launch" or "Play" etc.

Description()

const TDesC &

Description

(

)

const [pure virtual]

Retrieves the node description in text format.

Details()

const RPointerArray < CNcdKeyValuePair > &

Details

(

)

const [pure virtual]

Gets the details of this node. Details are additional information that can be used e.g. to categorize nodes. Details are represented as key-value pairs, for example: "artist:artist_name" or "album:album_name".

Disclaimer()

MNcdQuery *

Disclaimer

(

)

const [pure virtual]

Gets the disclaimer for the node in a query format.

Note:

Query is used here just to give disclaimer information. The metadata object does not care how the query is handled by the caller. SetResponseL of the query may be used but the given response is not saved into the database. Instead the set response information is availabe only while the metadata object is alive. Use MNcdNodeUserData interface object if information about acception or rejection of the disclaimer should be saved to the database.

Id()

const TDesC &

(

)

const [pure virtual]

Gets the metadata id.

IsAlwaysVisible()

TBool

IsAlwaysVisible

(

)

const [pure virtual]

Determines if the node is specified to be "always visible" in the client UI. What this actually means is determined by the UI client implementation. The idea is to give maximum visibility and availability to the item for the user.

LayoutType()

const TDesC &

LayoutType

(

)

const [pure virtual]

Retrieves the layout type in text format.

MoreInfo()

MNcdQuery *

MoreInfo

(

)

const [pure virtual]

Gets the more info for the node in a query format. This is a message with a body of text to be shown.

Note:

Query is used here just to give more info information. The metadata object does not care how the query is handled by the caller. SetResponseL of the query may be used but the given response is not saved into the database.

Name()

const TDesC &

Name

(

)

const [pure virtual]

Retrieves the node name in text format.

Namespace()

const TDesC &

Namespace

(

)

const [pure virtual]

All nodes and their content are part of a namespace. Within the namespace, identifiers are unique. This function returns the namespace of this metadata and its contents. This namespace should always be same as the namespace of the node that may own this metadata.