RCmDestination Class Reference

#include <mw/cmdestination.h>

Link against: cmmanager.lib

class RCmDestination

Public Member Functions
	RCmDestination()
	RCmDestination(const RCmDestination &)
	~RCmDestination()
IMPORT_C TInt	AddConnectionMethodL(RCmConnectionMethod)
IMPORT_C TInt	AddEmbeddedDestinationL(const RCmDestination &)
IMPORT_C void	Close()
IMPORT_C RCmConnectionMethod	ConnectionMethodByIDL(TInt)
IMPORT_C TInt	ConnectionMethodCount()
IMPORT_C RCmConnectionMethod	ConnectionMethodL(TInt)
IMPORT_C RCmConnectionMethod	CreateConnectionMethodL(TUint32)
IMPORT_C RCmConnectionMethod	CreateConnectionMethodL(TUint32, TUint32)
IMPORT_C void	DeleteConnectionMethodL(RCmConnectionMethod &)
IMPORT_C void	DeleteLD()
IMPORT_C TUint32	ElementId()
IMPORT_C CGulIcon *	IconL()
IMPORT_C TUint32	Id()
IMPORT_C TBool	IsConnectedL()
IMPORT_C TBool	IsHidden()
IMPORT_C TUint32	MetadataL(CMManager::TSnapMetadataField)
IMPORT_C void	ModifyPriorityL(RCmConnectionMethod &, TUint)
IMPORT_C HBufC *	NameLC()
IMPORT_C TUint	PriorityL(const RCmConnectionMethod &)
IMPORT_C CMManager::TProtectionLevel	ProtectionLevel()
IMPORT_C void	RemoveConnectionMethodL(RCmConnectionMethod)
IMPORT_C void	SetHiddenL(TBool)
IMPORT_C void	SetIconL(TUint32)
IMPORT_C void	SetMetadataL(CMManager::TSnapMetadataField, TUint32)
IMPORT_C void	SetNameL(const TDesC &)
IMPORT_C void	SetProtectionL(CMManager::TProtectionLevel)
IMPORT_C void	UpdateL()
IMPORT_C TBool	operator!=(const RCmDestination &)
IMPORT_C RCmDestination &	operator=(const RCmDestination &)
IMPORT_C TBool	operator==(const RCmDestination &)

Detailed Description

RCmDestination is for setting/getting values of a network destination.

Since: S60 v3.2

Constructor & Destructor Documentation

RCmDestination ( )

IMPORT_C

RCmDestination

(

)

Default constructor.

RCmDestination ( const RCmDestination & )

IMPORT_C

RCmDestination

(

const RCmDestination &

aCmDestination

)

~RCmDestination ( )

IMPORT_C

~RCmDestination

(

)

Member Function Documentation

AddConnectionMethodL ( RCmConnectionMethod )

IMPORT_C TInt

AddConnectionMethodL

(

RCmConnectionMethod

aConnectionMethod

)

AddEmbeddedDestinationL ( const RCmDestination & )

IMPORT_C TInt

AddEmbeddedDestinationL

(

const RCmDestination &

aDestination

)

Close ( )

IMPORT_C void

(

)

Close the session.

Since: S60 3.2

ConnectionMethodByIDL ( TInt )

IMPORT_C RCmConnectionMethod

ConnectionMethodByIDL

(

TInt

aCmId

)

const

Returns the connection method with the ECmId. Leaves with KErrNotFound if not found.

Parameter	Description
aCmId	unique id of the requested connection method.

Returns: connection method

ConnectionMethodCount ( )

IMPORT_C TInt

ConnectionMethodCount

(

)

const

Returns the number of connection methods of the destination

Since: 3.2

Returns: the number of connection methods belonging to a destination

ConnectionMethodL ( TInt )

IMPORT_C RCmConnectionMethod

ConnectionMethodL

(

TInt

anIndex

)

const

Returns a reference to the connection method. The index must be less than the return value of ConnectionMethodCount().

Since: 3.2

Returns: a connection method

CreateConnectionMethodL ( TUint32 )

IMPORT_C RCmConnectionMethod

CreateConnectionMethodL

(

TUint32

aBearerType

)

Create a connection method that belongs to this destination.

Returns: newly created connection method

CreateConnectionMethodL ( TUint32, TUint32 )

IMPORT_C RCmConnectionMethod	CreateConnectionMethodL	(	TUint32	aBearerType,
			TUint32	aConnMethId
		)

Create a connection method with given id that belongs to this destination.

Returns: newly created connection method or leaves with KErrAlreadyExists if there exists CM with the same Id.

DeleteConnectionMethodL ( RCmConnectionMethod & )

IMPORT_C void

DeleteConnectionMethodL

(

RCmConnectionMethod &

aConnectionMethod

)

Remove a connection method from a destination and delete it on update. Exception: conenction method is not deleted if it's referenced from any other destination.

Parameter	Description
aConnectionMethod	the connection method to be deleted.

DeleteLD ( )

IMPORT_C void

DeleteLD

(

)

Delete destination and its connection methods from CommsDat. Connection methods that belong to other destination, too, are not deleted.

ElementId ( )

IMPORT_C TUint32

ElementId

(

)

const

Returns the destination's ElementId attribute

Since: 3.2

Returns: the destination's element id

IconL ( )

IMPORT_C CGulIcon *

IconL

(

)

const

Returns the Icon pointer This function leaves if the client does not have a valid UI context

Since: 3.2

Returns: the destination icon

Id ( )

IMPORT_C TUint32

(

)

const

Returns the destination's Id attribute

Since: 3.2

Returns: the destination's id

IsConnectedL ( )

IMPORT_C TBool

IsConnectedL

(

)

const

Returns if there's a connection created with any of the destination's connection method.

Since: 3.2

Returns: ETrue if there's a connection with any of the destination's connection method.

IsHidden ( )

IMPORT_C TBool

IsHidden

(

)

const

Returns whether the destination is hidden or not.

Since: 3.2

Returns: ETrue if the destination is hidden

MetadataL ( CMManager::TSnapMetadataField )

IMPORT_C TUint32

MetadataL

(

CMManager::TSnapMetadataField

aMetaField

)

const

Returns the Metadata

Since: 3.2

Parameter	Description
aMetaField	the meta data field to query

Returns: the value of the requested field

ModifyPriorityL ( RCmConnectionMethod &, TUint )

IMPORT_C void	ModifyPriorityL	(	RCmConnectionMethod &	aCCMItem,
			TUint	aIndex
		)

Set the connection method's priority based on the passed index.

Parameter	Description
aCCMItem	the connection method item
aIndex	the new priority of the connection method in the destination

NameLC ( )

IMPORT_C HBufC *

NameLC

(

)

const

Returns the destination's Name attribute HBuf ownership is passed to the caller

Since: 3.2

Returns: HBufC* Passes returned value's ownership to the caller

PriorityL ( const RCmConnectionMethod & )

IMPORT_C TUint

PriorityL

(

const RCmConnectionMethod &

aCCMItem

)

const

Return the priority of the passed connection method

Since: 3.2

Parameter	Description
aCCMItem	connection method

Returns: the priority of the queried connection method

ProtectionLevel ( )

IMPORT_C CMManager::TProtectionLevel

ProtectionLevel

(

)

const

Return the protection level of the destination.

Since: 3.2

Returns: protection level of the destination

RemoveConnectionMethodL ( RCmConnectionMethod )

IMPORT_C void

RemoveConnectionMethodL

(

RCmConnectionMethod

aConnectionMethod

)

Remove connection method from the destination

Parameter	Description
aConnectionMethod	connection method to be removed

SetHiddenL ( TBool )

IMPORT_C void

SetHiddenL

(

TBool

aHidden

)

Set if the destination is hidden or not.

Parameter	Description
aHidden	- ETrue if destination is hidden

SetIconL ( TUint32 )

IMPORT_C void

SetIconL

(

TUint32

anIndex

)

Set the destination's icon index. This fucton leaves if the client does not have a valid UI context

SetMetadataL ( CMManager::TSnapMetadataField, TUint32 )

IMPORT_C void	SetMetadataL	(	CMManager::TSnapMetadataField	aMetaField,
			TUint32	aValue
		)

Set the Metadata

Parameter	Description
aMetaField	field to be modified
aValue	value to be set

SetNameL ( const TDesC & )

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Set the destination's name

SetProtectionL ( CMManager::TProtectionLevel )

IMPORT_C void

SetProtectionL

(

CMManager::TProtectionLevel

aProtLevel

)

Set the protection level of the destination.

Parameter	Description
aProtLevel	new protection level

UpdateL ( )

IMPORT_C void

UpdateL

(

)

Update all values of the destination and its connection method. Nothing if stored, if update leaves due to any reason.

operator!= ( const RCmDestination & )

IMPORT_C TBool

operator!=

(

const RCmDestination &

aDestination

)

const

checks if destinations are not the same

Since: S60 3.2

Parameter	Description
aDestination	the destination being compared

Returns: ETrue if the destinations are different

operator= ( const RCmDestination & )

IMPORT_C RCmDestination &

operator=

(

const RCmDestination &

aCmDestination

)

assignment operator

Since: S60 3.2

Returns: RCmDestination

operator== ( const RCmDestination & )

IMPORT_C TBool

operator==

(

const RCmDestination &

aDestination

)

const

checks if destinations are the same

Since: S60 3.2

Parameter	Description
aDestination	the destination being compared

Returns: ETrue if the destinations are the same