Collapse all Symbian^3 Application Developer Library

MAknNotifierWrapper Class Reference

class MAknNotifierWrapper

Avkon notifier wrapper interface.

Abstract class for accessing an object implementing actual client-session to Notifier App Server.

aknnotifierwrapper.lib

Since: S60 v3.0

Public Member Functions
const TUid &	AppServerUid ()
void	AsyncMessageCompleted ( CAknNotifierMessageObserver *)
void	CancelNotifier ( TUid )
void	StartNotifierL ( TUid , const TDesC8 &, TInt , const RMessagePtr2 &)
TPtrC8	StartNotifierL ( TUid , const TDesC8 &)
TPtr8	SynchronousReplyBuf ()
TPtrC8	UpdateNotifierL ( TUid , const TDesC8 &)
IMPORT_C void	UpdateNotifierL ( TUid , const TDesC8 &, TInt , const RMessagePtr2 &)

Member Functions Documentation

AppServerUid()

const TUid &

AppServerUid

(

)

const [pure virtual]

Return unique identifier of server application implmenting the service

Since: 3.0

AsyncMessageCompleted(CAknNotifierMessageObserver *)

void

AsyncMessageCompleted

(

CAknNotifierMessageObserver *

aEntry

)

[pure virtual]

Callback method, called when async request from app server completes.

Since: 3.0

Parameters

CAknNotifierMessageObserver * aEntry

queue object which was completed by app server. Called before FW completes request from client using RNotifier. Instance implementing this API, may complete the message during this method if default implementation is not suitable (just writes the reply from client to replyslot given)

CancelNotifier(TUid)

void

CancelNotifier

(

TUid

aNotifierUid

)

[pure virtual]

Command session owning object to cancel a notifier with given uid Method is synchronous

Since: 3.0

Parameters

TUid aNotifierUid

Notifier to be cancelled

StartNotifierL(TUid, const TDesC8 &, TInt, const RMessagePtr2 &)

void	StartNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer,
			TInt	aReplySlot,
			const RMessagePtr2 &	aMessage
		)	[pure virtual]

Command session owning object to start a notifier with given uid Method is asynchronous. On error leaves with standard Symbian OS error code.

Since: 3.0

Parameters

TUid aNotifierUid	Notifier to be started
const TDesC8 & aBuffer	Buffer from RNotifier client
TInt aReplySlot	to which slot plugin will write its reply
const RMessagePtr2 & aMessage	Message into which reply is written when async request is completed

StartNotifierL(TUid, const TDesC8 &)

TPtrC8	StartNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer
		)	[pure virtual]

Command session owning object to start a notifier with given uid Method is synchronous. On error leaves with standard Symbian OS error code.

Since: 3.0

Parameters

TUid aNotifierUid	Notifier to be started
const TDesC8 & aBuffer	Buffer from RNotifier client

SynchronousReplyBuf()

TPtr8

SynchronousReplyBuf

(

)

[pure virtual]

Return reference to buffer used in syncronous commands to store reply before sending it to client.

Since: 3.0

UpdateNotifierL(TUid, const TDesC8 &)

TPtrC8	UpdateNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer
		)	[pure virtual]

Command session owning object to update a notifier with given uid Method is synchronous. On error leaves with standard Symbian OS error code.

Since: 3.0

Parameters

TUid aNotifierUid	Notifier to be updated
const TDesC8 & aBuffer	Buffer from RNotifier client

UpdateNotifierL(TUid, const TDesC8 &, TInt, const RMessagePtr2 &)

IMPORT_C void	UpdateNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer,
			TInt	aReplySlot,
			const RMessagePtr2 &	aMessage
		)	[virtual]

Command session owning object to update a notifier with given uid Method is asynchronous. On error leaves with standard Symbian OS error code.

This method was added to 3.2 and in order to preserve SC it has a default implementation which leaves with KErrNotSupported .

Since: 3.2

Parameters

TUid aNotifierUid	Notifier to be updated
const TDesC8 & aBuffer	Buffer from RNotifier client
TInt aReplySlot	To which slot plugin will write its reply
const RMessagePtr2 & aMessage	Message into which reply is written when async request is completed