RCmManager Class Reference

#include <mw/cmmanager.h>

Link against: cmmanager.lib

class RCmManager
Public Member Functions
RCmManager()
IMPORT_C voidAllDestinationsL(RArray< TUint32 > &)
IMPORT_C voidBearerPriorityArrayL(RArray< TBearerPriority > &)
IMPORT_C voidCleanupGlobalPriorityArray(RArray< TBearerPriority > &)
IMPORT_C voidClose()
IMPORT_C RCmConnectionMethodConnectionMethodL(TUint32)
IMPORT_C voidConnectionMethodL(RArray< TUint32 > &, TBool, TBool, TBool)
IMPORT_C TIntCopyConnectionMethodL(RCmDestination &, RCmConnectionMethod &)
IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32)
IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32, TUint32)
IMPORT_C RCmDestinationCreateDestinationL(const TDesC &)
IMPORT_C RCmDestinationCreateDestinationL(const TDesC &, TUint32)
IMPORT_C voidCreateTablesAndOpenL()
IMPORT_C RCmDestinationDestinationL(TUint32)
IMPORT_C TUint32EasyWlanIdL()
IMPORT_C TBoolGetBearerInfoBoolL(TUint32, TUint32)
IMPORT_C TUint32GetBearerInfoIntL(TUint32, TUint32)
IMPORT_C HBufC8 *GetBearerInfoString8L(TUint32, TUint32)
IMPORT_C HBufC *GetBearerInfoStringL(TUint32, TUint32)
IMPORT_C TBoolGetConnectionMethodInfoBoolL(TUint32, TUint32)
IMPORT_C TUint32GetConnectionMethodInfoIntL(TUint32, TUint32)
IMPORT_C HBufC8 *GetConnectionMethodInfoString8L(TUint32, TUint32)
IMPORT_C HBufC *GetConnectionMethodInfoStringL(TUint32, TUint32)
IMPORT_C TIntMoveConnectionMethodL(RCmDestination &, RCmDestination &, RCmConnectionMethod &)
IMPORT_C voidOpenL()
IMPORT_C voidOpenLC()
IMPORT_C voidReadDefConnL(TCmDefConnValue &)
IMPORT_C voidReadGenConnSettingsL(TCmGenConnSettings &)
IMPORT_C voidRemoveAllReferencesL(RCmConnectionMethod &)
IMPORT_C voidRemoveConnectionMethodL(RCmDestination &, RCmConnectionMethod &)
IMPORT_C voidSupportedBearersL(RArray< TUint32 > &)
IMPORT_C CGulIcon *UncategorizedIconL()
IMPORT_C voidUpdateBearerPriorityArrayL(const RArray< TBearerPriority > &)
IMPORT_C voidWriteDefConnL(const TCmDefConnValue &)
IMPORT_C voidWriteGenConnSettingsL(const TCmGenConnSettings &)

Detailed Description

RCmManager gives access to network destinations and connection methods.

Since
S60 v3.2

Constructor & Destructor Documentation

RCmManager ( )

RCmManager()[inline]

Default constructor.

Member Function Documentation

AllDestinationsL ( RArray< TUint32 > & )

IMPORT_C voidAllDestinationsL(RArray< TUint32 > &aDestArray)const

Returns an array of all destination id's

Since
S60 3.2
ParameterDescription
aDestArraylist all available destinations' id

BearerPriorityArrayL ( RArray< TBearerPriority > & )

IMPORT_C voidBearerPriorityArrayL(RArray< TBearerPriority > &aArray)const

Returns the copy of the bearer priority array. Ownership is passed.

Since
S60 3.2
ParameterDescription
aArraybearer priority array

CleanupGlobalPriorityArray ( RArray< TBearerPriority > & )

IMPORT_C voidCleanupGlobalPriorityArray(RArray< TBearerPriority > &aArray)const

Clean up passed global bearer priority array. Delete the elements and calls Reset and Close on the array.

Since
S60 3.2
ParameterDescription
aArrayarray to be cleaned up

Close ( )

IMPORT_C voidClose()

Secondary destructor

Since
S60 3.2

ConnectionMethodL ( TUint32 )

IMPORT_C RCmConnectionMethodConnectionMethodL(TUint32aConnectionMethodId)const

Returns the connection method queried by its ID

Since
S60 3.2
ParameterDescription
aConnectionMethodIdid of the connection method

Returns: RCmConnectionMethod connection method

ConnectionMethodL ( RArray< TUint32 > &, TBool, TBool, TBool )

IMPORT_C voidConnectionMethodL(RArray< TUint32 > &aCMArray,
TBoolaCheckBearerType = ETrue,
TBoolaLegacyOnly = ETrue,
TBoolaEasyWlan = EFalse
)const

Returns the list of connection methods. Connection Methods are filtered by the switch parameters e.g. aLegacyOnly.

Since
S60 3.2
ParameterDescription
aCMArrayon return it is the array of IAP ids.
aCheckBearerTypeIf ETrue only connection methods with supported bearer type are returned
aLegacyOnlywhen set to ETrue only Legacy IAP ids will be returned
aEasyWlanwhen set to ETrue EasyWlan id is returned, too

CopyConnectionMethodL ( RCmDestination &, RCmConnectionMethod & )

IMPORT_C TIntCopyConnectionMethodL(RCmDestination &aTargetDestination,
RCmConnectionMethod &aConnectionMethod
)

Copies a connection method belonging to one destination to another. The connection method becomes shared. Calls UpdateL on the destination

Returns: TInt - index in the Connection Method list

CreateConnectionMethodL ( TUint32 )

IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32aBearerType)

Creates a connection method does not belong to any destination

Returns: RCmConnectionMethod newly created connection method.

CreateConnectionMethodL ( TUint32, TUint32 )

IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32aImplementationUid,
TUint32aConnMethodId
)

Creates a connection method does not belong to any destination

ParameterDescription
aImplementationUid- bearer type of the new connection method
aConnMethodIdPredefined id for the connection method.

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

CreateDestinationL ( const TDesC & )

IMPORT_C RCmDestinationCreateDestinationL(const TDesC &aName)

Creates a Destination with the passed name.

ParameterDescription
aNamethe name of the new destination.

Returns: RCmDestination new destination. ownership is passed to the caller

CreateDestinationL ( const TDesC &, TUint32 )

IMPORT_C RCmDestinationCreateDestinationL(const TDesC &aName,
TUint32aDestId
)

Creates a Destination with the passed name and id.

ParameterDescription
aNamethe name of the new destination.
aDestIdPredefined id of the destination.

Returns: RCmDestination newly created destination or leaves with KErrAlreadyExists if there exists CM with the same Id. Ownership is passed to the caller.

CreateTablesAndOpenL ( )

IMPORT_C voidCreateTablesAndOpenL()

Open session and create tables if they don't exist

DestinationL ( TUint32 )

IMPORT_C RCmDestinationDestinationL(TUint32aDestinationId)const

Returns the destination to which a specified connection method belongs, search is by destination ID

Since
S60 3.2
ParameterDescription
aDestinationIdid of destination

Returns: RCmDestination network destination

EasyWlanIdL ( )

IMPORT_C TUint32EasyWlanIdL()const

Returns the id of the EasyWlan connection method.

Since
S60 3.2

Returns: id of the EasyWLan connection method. 0 if not found.

GetBearerInfoBoolL ( TUint32, TUint32 )

IMPORT_C TBoolGetBearerInfoBoolL(TUint32aBearerType,
TUint32aAttribute
)const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Since
S60 3.2
ParameterDescription
aBearerTypethe bearer
aAttributethe setting value

Returns: the setting value

GetBearerInfoIntL ( TUint32, TUint32 )

IMPORT_C TUint32GetBearerInfoIntL(TUint32aBearerType,
TUint32aAttribute
)const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Since
S60 3.2
ParameterDescription
aBearerTypethe bearer
aAttributethe setting value

Returns: the setting value

GetBearerInfoString8L ( TUint32, TUint32 )

IMPORT_C HBufC8 *GetBearerInfoString8L(TUint32aBearerType,
TUint32aAttribute
)const

Used to query bearer information that does not belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority, etc. HBuf ownership is passed to the caller

Since
S60 3.2
ParameterDescription
aBearerTypethe bearer
aAttributethe setting value

Returns: the setting value

GetBearerInfoStringL ( TUint32, TUint32 )

IMPORT_C HBufC *GetBearerInfoStringL(TUint32aBearerType,
TUint32aAttribute
)const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc. HBuf ownership is passed to the caller

Since
S60 3.2
ParameterDescription
aBearerTypethe bearer
aAttributethe setting value

Returns: the setting value

GetConnectionMethodInfoBoolL ( TUint32, TUint32 )

IMPORT_C TBoolGetConnectionMethodInfoBoolL(TUint32aIapId,
TUint32aAttribute
)const

Used to query any, non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Since
S60 3.2
ParameterDescription
aIapIdthe connection method id
aAttributethe setting value

Returns: the setting value

GetConnectionMethodInfoIntL ( TUint32, TUint32 )

IMPORT_C TUint32GetConnectionMethodInfoIntL(TUint32aIapId,
TUint32aAttribute
)const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Since
S60 3.2
ParameterDescription
aIapIdthe connection method id
aAttributethe setting value

Returns: the setting value

GetConnectionMethodInfoString8L ( TUint32, TUint32 )

IMPORT_C HBufC8 *GetConnectionMethodInfoString8L(TUint32aIapId,
TUint32aAttribute
)const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Since
S60 3.2
ParameterDescription
aIapIdthe connection method id
aAttributethe setting value

Returns: the setting value

GetConnectionMethodInfoStringL ( TUint32, TUint32 )

IMPORT_C HBufC *GetConnectionMethodInfoStringL(TUint32aIapId,
TUint32aAttribute
)const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Since
S60 3.2
ParameterDescription
aIapIdthe connection method id
aAttributethe setting value

Returns: the setting value

MoveConnectionMethodL ( RCmDestination &, RCmDestination &, RCmConnectionMethod & )

IMPORT_C TIntMoveConnectionMethodL(RCmDestination &aSourceDestination,
RCmDestination &aTargetDestination,
RCmConnectionMethod &aConnectionMethod
)

Moves a connection method belonging to one destination to another. The connection method is removed from the source destination

Returns: TInt - index in the Connection Method list

OpenL ( )

IMPORT_C voidOpenL()

Symbian constructor

Since
S60 3.2

OpenLC ( )

IMPORT_C voidOpenLC()

Symbian constructor Pushes the object on the cleanup stack

Since
S60 3.2

ReadDefConnL ( TCmDefConnValue & )

IMPORT_C voidReadDefConnL(TCmDefConnValue &aDCSetting)

Returns the default connection method/SNAP.

Since
S60 3.2

ReadGenConnSettingsL ( TCmGenConnSettings & )

IMPORT_C voidReadGenConnSettingsL(TCmGenConnSettings &aGenConnSettings)

Returns the general connection settings.

Since
S60 9.2

RemoveAllReferencesL ( RCmConnectionMethod & )

IMPORT_C voidRemoveAllReferencesL(RCmConnectionMethod &aConnectionMethod)

Removes connection method from every destination and make it uncategorized.

ParameterDescription
aConnectionMethodconnection method to be removed

RemoveConnectionMethodL ( RCmDestination &, RCmConnectionMethod & )

IMPORT_C voidRemoveConnectionMethodL(RCmDestination &aDestination,
RCmConnectionMethod &aConnectionMethod
)

Remove connection method from the destination

ParameterDescription
aDestinationdestination the connection method is attached to
aConnectionMethodconnection method to be removed

SupportedBearersL ( RArray< TUint32 > & )

IMPORT_C voidSupportedBearersL(RArray< TUint32 > &aArray)const

Query all of the supported bearer types.

ParameterDescription
aArraylist of all supported bearer types.

UncategorizedIconL ( )

IMPORT_C CGulIcon *UncategorizedIconL()const

Returns "Uncategorized" icon. This fucton leaves if the client does not have a valid UI context

Returns: CGulIcon* Icon of uncategorized connection methods. Ownership is passed.

UpdateBearerPriorityArrayL ( const RArray< TBearerPriority > & )

IMPORT_C voidUpdateBearerPriorityArrayL(const RArray< TBearerPriority > &aArray)

Update bearer priority array

ParameterDescription
aArrayarray with new global bearer priority

WriteDefConnL ( const TCmDefConnValue & )

IMPORT_C voidWriteDefConnL(const TCmDefConnValue &aDCSetting)

Stores the default connection method/SNAP.

Since
S60 3.2

WriteGenConnSettingsL ( const TCmGenConnSettings & )

IMPORT_C voidWriteGenConnSettingsL(const TCmGenConnSettings &aGenConnSettings)

Writes the general connection settings.

Since
S60 9.2
© Nokia 2011.