Collapse all Symbian^3 Application Developer Library

MCCAParameter Class Reference

class MCCAParameter

Public Member Functions
TAny *	CcaParameterExtension ( TUid )
void	Close ()
TConnectionFlags	ConnectionFlag ()
TContactDataFlags	ContactDataFlag ()
HBufC &	ContactDataL ()
TUid	LaunchedViewUid ()
void	SetConnectionFlag (const TConnectionFlags )
void	SetContactDataFlag (const TContactDataFlags )
void	SetContactDataL (const TDesC &)
void	SetLaunchedViewUid (const TUid )
TInt32	Version ()

Public Member Enumerations
enum	TConnectionFlags { ENormal = 0x00000001, ESoftExit = 0x00000002 }
enum	TContactDataFlags { EContactNone = 0, EContactId , EContactLink , EContactMSISDN , EContactDataModel }

Member Functions Documentation

CcaParameterExtension(TUid)

TAny *

CcaParameterExtension

(

TUid

)

[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

Close()

void

(

)

[pure virtual]

Destroy this parameter entity and all its data.

Since: S60 5.0

ConnectionFlag()

TConnectionFlags

ConnectionFlag

(

)

[pure virtual]

Getter for the flags of connection.

Since: S60 5.0

ContactDataFlag()

TContactDataFlags

ContactDataFlag

(

)

[pure virtual]

Getter for the contact data flags.

Since: S60 5.0

ContactDataL()

HBufC &

ContactDataL

(

)

[pure virtual]

Getter for the contact data.

leave: KErrArgument if data not set.

Since: S60 5.0

LaunchedViewUid()

TUid

LaunchedViewUid

(

)

[pure virtual]

Getter for the view uid.

Since: S60 5.0

SetConnectionFlag(const TConnectionFlags)

void

SetConnectionFlag

(

const TConnectionFlags

aConnectionFlags

)

[pure virtual]

Setter for the flag of connection.

TConnectionFlags

Since: S60 5.0

Parameters

const TConnectionFlags aConnectionFlags

SetContactDataFlag(const TContactDataFlags)

void

SetContactDataFlag

(

const TContactDataFlags

aContactDataFlags

)

[pure virtual]

Setter for the contact data flag.

TContactDataFlags

Since: S60 5.0

Parameters

const TContactDataFlags aContactDataFlags

SetContactDataL(const TDesC &)

void

SetContactDataL

(

const TDesC &

aContactData

)

[pure virtual]

Setter for the contact data. If you are using TContactDataFlags::EContactLink, the MVPbkContactLink should be streamed with PackLC before given for this method. Ownership is NOT transferred. MVPbkContactLink from Virtual phonebook.

leave: KErrNotFound if contact data flag is not set before calling this method.

MCCAParameter::SetContactDataFlags

Since: S60 5.0

Parameters

const TDesC & aContactData

SetLaunchedViewUid(const TUid)

void

SetLaunchedViewUid

(

const TUid

aUid

)

[pure virtual]

Setter for the launched view uid. Use this when there is need to get a particular view opened first on launch of CCA. If view uid is not set, CCA uses the default view.

Since: S60 5.0

Parameters

const TUid aUid

Version()

TInt32

Version

(

)

[pure virtual]

Getter for the version.

Since: S60 5.0

Member Enumerations Documentation

Enum TConnectionFlags

Flags for controlling opening and closing of CCA application

Enumerators

ENormal = 0x00000001
ESoftExit = 0x00000002

Enum TContactDataFlags

Flags for indicating type of contact data

Notes related to specific search types below: EContactId EContactLink

Enumerators

EContactNone = 0
EContactId
EContactLink
EContactMSISDN
EContactDataModel