Collapse all Symbian^3 Product Developer Library

CMediatorCommandResponder Class Reference

class CMediatorCommandResponder : public CBase

A class used to respond to Mediator Service commands.

MediatorClient.lib

Since: S60 3.1

Inherits from

CMediatorCommandResponder
- CBase

Public Member Functions
	~CMediatorCommandResponder()
IMPORT_C TInt	IssueResponse(TUid, TUid, TInt, TInt, const TDesC8 &)
IMPORT_C CMediatorCommandResponder *	NewL(MMediatorCommandObserver *)
IMPORT_C TInt	RegisterCommand(TUid, TUid, const MediatorService::RCommandList &)
IMPORT_C TInt	RegisterCommand(TUid, TUid, TInt, TVersion, TCapabilitySet, TInt)
IMPORT_C TInt	UnregisterCommand(TUid, TUid, const MediatorService::RCommandList &)
IMPORT_C TInt	UnregisterCommand(TUid, TUid, TInt)

Private Member Functions
	CMediatorCommandResponder()
void	ConstructL(MMediatorCommandObserver *)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CMediatorCommandResponderBody *	iBody

Constructor & Destructor Documentation

CMediatorCommandResponder()

CMediatorCommandResponder

(

)

[private]

C++ default constructor.

~CMediatorCommandResponder()

~CMediatorCommandResponder

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL(MMediatorCommandObserver *)

void

ConstructL

(

MMediatorCommandObserver *

aObserver

)

[private]

By default Symbian 2nd phase constructor is private.

Parameters

MMediatorCommandObserver * aObserver

mediator command observer

IssueResponse(TUid, TUid, TInt, TInt, const TDesC8 &)

IMPORT_C TInt	IssueResponse	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId,
			TInt	aStatus,
			const TDesC8 &	aData
		)

Issue a response to a command.

Since: S60 3.1

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
TInt aCommandId	The identifier of the command.
TInt aStatus	Result status of the command.
const TDesC8 & aData	The parameters of the response.

NewL(MMediatorCommandObserver *)

IMPORT_C CMediatorCommandResponder *

NewL

(

MMediatorCommandObserver *

aObserver

)

[static]

Two-phased constructor.

Parameters

MMediatorCommandObserver * aObserver

mediator command observer

RegisterCommand(TUid, TUid, const MediatorService::RCommandList &)

IMPORT_C TInt	RegisterCommand	(	TUid	aDomain,
			TUid	aCategory,
			const MediatorService::RCommandList &	aCommands
		)

Since: S60 3.1

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
const MediatorService::RCommandList & aCommands	The command list to be registered.

RegisterCommand(TUid, TUid, TInt, TVersion, TCapabilitySet, TInt)

IMPORT_C TInt	RegisterCommand	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId,
			TVersion	aVersion,
			TCapabilitySet	aCaps,
			TInt	aTimeOut
		)

Since: S60 3.1

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
TInt aCommandId	The identifier of the category.
TVersion aVersion	The version of the command
TCapabilitySet aCaps	Capabilities required for initiating the command.
TInt aTimeOut

UnregisterCommand(TUid, TUid, const MediatorService::RCommandList &)

IMPORT_C TInt	UnregisterCommand	(	TUid	aDomain,
			TUid	aCategory,
			const MediatorService::RCommandList &	aCommands
		)

Unregister a command category.

Since: S60 3.1

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
const MediatorService::RCommandList & aCommands	List of commands to be unregistered.

UnregisterCommand(TUid, TUid, TInt)

IMPORT_C TInt	UnregisterCommand	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId
		)

Unregister a command.

Since: S60 3.1

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
TInt aCommandId	The identifier of the category.

Member Data Documentation

CMediatorCommandResponderBody * iBody

CMediatorCommandResponderBody *

iBody

[private]

Pointer to implementation class Own.