RMMFResourceNotificationCustomCommands Class Reference

#include "mmfstandardcustomcommands.h"

Link against: mmfstandardcustomcommands.lib

class RMMFResourceNotificationCustomCommands : public RMMFCustomCommandsBase

Inherits from

Detailed Description

Client class to allow the client to register notification .

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Since
7.0s

Constructor & Destructor Documentation

RMMFResourceNotificationCustomCommands ( RMMFController & )

IMPORT_CRMMFResourceNotificationCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s
ParameterDescription
aControllerThe client side controller object to be used by this custom command interface.

Member Function Documentation

CancelRegisterAsClient ( TUid )

IMPORT_C TIntCancelRegisterAsClient(TUidaEventType)

Cancels the registered notification event.

ParameterDescription
aEventTypeThe Event to notify the client.

Returns: An error code indicating if the cancel registration was successful. KErrNone on success, otherwise another of the system-wide error codes.

GetResourceNotificationData ( TUid, TDes8 & )

IMPORT_C TIntGetResourceNotificationData(TUidaEventType,
TDes8 &aNotificationData
)

Gets the notification data for the event.

ParameterDescription
aEventTypeThe Event to notify the client.
aNotificationDataThe Notification data for the client to resume the play.

Returns: An error code indicating if the get notification data was successful. KErrNone on success, otherwise another of the system-wide error codes.

RegisterAsClient ( TUid, const TDesC8 & )

IMPORT_C TIntRegisterAsClient(TUidaEventType,
const TDesC8 &aNotificationRegistrationData
)

Registers the Event for Notification when resource is avaliable.

ParameterDescription
aEventTypeThe Event to notify the client.
aNotificationRegistrationDataNotification registration specific data.

Returns: An error code indicating if the registration was successful. KErrNone on success, otherwise another of the system-wide error codes.

WillResumePlay ( )

IMPORT_C TIntWillResumePlay()

Waits for the client to resume the play even after the default timer expires.

Returns: An error code indicating if the registration was successful. KErrNone on success, otherwise any of the system-wide error codes.