S60 3 2 Connection Settings API Specification C: API description

Connection Method Manager API provides:

• access functions to read existing Destinations and Connection Methods,
• access functions to read the attributes of Connection Methods,
• access functions to read the attributes of a bearer type.

CM Manager runs in the process of the client application. All the methods in the API are synchronous. Some UI related methods such as queering a bearer icon (ECmBearerIcon) requires UI context from the client application.

As CM Manager runs in the process of the client application it has the same capabilities as the client application so the client application needs the ReadDeviceData capability to access 'private' user data such as user names or passwords through the API.

Use cases

The main use cases of the Connection Settings API are:

1. Read the list of existing Destinations.
2. Read the existing Connection Methods in a Destination.
3. Read the attributes of a Connection Method.
4. Read the attributes of a bearer type.

API class structure

The diagram below contains only the relevant details of the types of Connection Settings API. Full reference can be found in the header files.

• RCmManager is a general interface to Connection Method Manager. It can be used to get:
  • bearer specific information, e.g. ECmBearerHasUi to query if a bearer type has a UI dialog for the settings or not.
  • Connection Method specific information, e.g. ECmBearer type to query the bearer type of the Connection Method.
  • a Connection Method or a list of Connection Methods using ConnectionMethodL.
  • a list of Destinations using AllDestinationsL.
• RCmDestination is a representation of a Destination. It can be used to query the Connection Methods which belong to the given Destination.
• RCmConnectionMethod is a representation of a Connection Method. It can be used to query the attributes of a given Connection Method.

Connection Settings API also contains the following def header files which contain constants and enumerations inside the CMManager namespace, e.g. cmpluginhscsddef.h for HSCSD bearer type contains the TConnectionMethodHscsdSpecificAttributes enumeration type.

Some of these file names refer to plug-ins such as cmpluginhscsddef.h

• cmmanagerdef.h
• cmconnectionmethoddef.h
• cmpluginpacketdatadef.h
• cmplugindialcommondefs.h
• cmplugincsddef.h
• cmpluginhscsddef.h
• cmpluginembdestinationdef.h
• cmpluginvpndef.h
• cmpluginwlandef.h

Although some of these file names refer to plug-ins such as cmpluginhscsddef.h the plug-in architecture (different bearer types are realized as plug-ins in the CM Manager) is hidden for the user of the API. Usage of the API does not require any knowledge about the plug-in architecture of CM Manager.

The rest of the headers contains the type definitions of the RCmManager, RCmDestination and the RCmConnectionMethod classes.

• cmmanager.h contains the type definition of RCmManager
• cmdestination.h contains the type definition of RCmDestination
• cmconnectionmethod.h contains the type definition of RCmConnectionMethod