RMMFCustomCommandsBase Class Reference

#include "mmfcontroller.h"

Link against: mmfcontrollerframework.lib

class RMMFCustomCommandsBase

Protected Attributes
RMMFController &	iController
TMMFMessageDestinationPckg	iDestinationPckg

Public Member Functions
	RMMFCustomCommandsBase(RMMFController &, TUid)

Detailed Description

Base class for client-side custom command classes.

In order facilitate the use of the more common custom commands, it is desirable to write a concrete API class for the client to use. This API class can then be use to wrap all the code involved to formulate the custom command messages.

Since: 7.0s

Member Attribute Documentation

iController

RMMFController &

iController

[protected]

The controller.

Derived classes should use iController.CustomCommandSync() and iController.CustomCommandAsync() to send the custom commands to the controller plugin.

iDestinationPckg

TMMFMessageDestinationPckg

iDestinationPckg

[protected]

The destination package.

Derived classes must pass this into iController.CustomCommandSync() and iController.CustomCommandAsync() as the destination argument.

Constructor & Destructor Documentation

RMMFCustomCommandsBase ( RMMFController &, TUid )

IMPORT_C	RMMFCustomCommandsBase	(	RMMFController &	aController,
			TUid	aInterfaceId
		)

Constructor.

Since: 7.0s

Parameter	Description
aController	A reference to the controller client class that will be used to send custom commands to the controller plugin.
aInterfaceId	The UID of the custom command interface that is provided by this client API class.