RNotifier Class Reference

class RNotifier : public RSessionBase

A handle to a session with the extended notifier server that provides support for plug-in notifiers.

The interface allows engines or other low level components to communicate with the UI.

Inherits from

Public Member Functions
RNotifier ()
IMPORT_C TInt CancelNotifier ( TUid )
IMPORT_C void Close ()
IMPORT_C TInt Connect ()
IMPORT_C TInt InfoPrint (const TDesC &)
IMPORT_C TInt LoadNotifiers ( TUid )
IMPORT_C void Notify (const TDesC &, const TDesC &, const TDesC &, const TDesC &, TInt &, TRequestStatus &)
IMPORT_C void NotifyCancel ()
IMPORT_C TInt StartNotifier ( TUid , const TDesC8 &)
IMPORT_C TInt StartNotifier ( TUid , const TDesC8 &, TDes8 &)
IMPORT_C TInt StartNotifier ( TUid , TUid , const TDesC8 &, TDes8 &)
IMPORT_C void StartNotifierAndGetResponse ( TRequestStatus &, TUid , const TDesC8 &, TDes8 &)
IMPORT_C void StartNotifierAndGetResponse ( TRequestStatus &, TUid , TUid , const TDesC8 &, TDes8 &)
IMPORT_C TInt UnloadNotifiers ( TUid )
IMPORT_C TInt UpdateNotifier ( TUid , const TDesC8 &, TDes8 &)
IMPORT_C void UpdateNotifierAndGetResponse ( TRequestStatus &, TUid , const TDesC8 &, TDes8 &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TPtr8 iButtonVal
HBufC16 * iCombinedBuffer
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RNotifier()

IMPORT_C RNotifier ( )

Default constructor.

Member Functions Documentation

CancelNotifier(TUid)

IMPORT_C TInt CancelNotifier ( TUid aNotifierUid )

Requests the extended notifier server to cancel the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Any notifier that was queued pending the completion of aNotifierUid will be automatically started.

Parameters

TUid aNotifierUid The UID identifying the notifier.

Close()

IMPORT_C void Close ( )

Closes the notifier.

Connect()

IMPORT_C TInt Connect ( )

Connects to the extended notifier server, creating a session with that server. Note: Notifier server is started during window server start-up sequence.

The function must be called before any other function.

InfoPrint(const TDesC &)

IMPORT_C TInt InfoPrint ( const TDesC & aDes )

Parameters

const TDesC & aDes

LoadNotifiers(TUid)

IMPORT_C TInt LoadNotifiers ( TUid aNotifierUid )

This function has never been implemented on any Symbian OS version. It always returns KErrNotSupported.

Parameters

TUid aNotifierUid

Notify(const TDesC &, const TDesC &, const TDesC &, const TDesC &, TInt &, TRequestStatus &)

IMPORT_C void Notify ( const TDesC & aLine1,
const TDesC & aLine2,
const TDesC & aBut1,
const TDesC & aBut2,
TInt & aButtonVal,
TRequestStatus & aStatus
)

Launches a simple two line dialog that displays two lines of text.

This is an asynchronous request that completes when the dialog exits.

Parameters

const TDesC & aLine1 A descriptor containing the first line of text to be displayed.
const TDesC & aLine2 A descriptor containing the second line of text to be displayed.
const TDesC & aBut1 A descriptor containing text to be displayed in the first button.
const TDesC & aBut2 A descriptor containing text to be displayed in the (optional) second button.
TInt & aButtonVal An integer value which is set when the dialog exits. It is set to: 0, if the first button is selected; 1, if the second button is selected.
TRequestStatus & aStatus The request status object. If the request completes normally, this is set to KErrNone.

NotifyCancel()

IMPORT_C void NotifyCancel ( )

Not implemented by the server.

StartNotifier(TUid, const TDesC8 &)

IMPORT_C TInt StartNotifier ( TUid aNotifierUid,
const TDesC8 & aBuffer
)

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not be started immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on.

CServer

Parameters

TUid aNotifierUid The UID identifying the notifier.
const TDesC8 & aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.

StartNotifier(TUid, const TDesC8 &, TDes8 &)

IMPORT_C TInt StartNotifier ( TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not start immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on. This can also cause unexpected behaviour: the function can return before the notifier has been started with the added consequence that no response data is written.

For this reason, this function has been deprecated. Instead, use RNotifier::StartNotifierAndGetResponse() , or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier() .

CServeruse RNotifier::StartNotifierAndGetResponse() , or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier()

Parameters

TUid aNotifierUid The UID identifying the notifier.
const TDesC8 & aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
TDes8 & aResponse Response data; the format and meaning of this depends on the notifier.

StartNotifier(TUid, TUid, const TDesC8 &, TDes8 &)

IMPORT_C TInt StartNotifier ( TUid aNotifierDllUid,
TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

Parameters

TUid aNotifierDllUid
TUid aNotifierUid
const TDesC8 & aBuffer
TDes8 & aResponse

StartNotifierAndGetResponse(TRequestStatus &, TUid, const TDesC8 &, TDes8 &)

IMPORT_C void StartNotifierAndGetResponse ( TRequestStatus & aRs,
TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

Requests the extended notifier server to start the notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

TRequestStatus & aRs The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
TUid aNotifierUid The UID identifying the notifier.
const TDesC8 & aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
TDes8 & aResponse Response data; the format and meaning of this depends on the notifier.

StartNotifierAndGetResponse(TRequestStatus &, TUid, TUid, const TDesC8 &, TDes8 &)

IMPORT_C void StartNotifierAndGetResponse ( TRequestStatus & aRs,
TUid aNotifierDllUid,
TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

This function has never been implemented on any Symbian OS version. The request always completes with KErrNotSupported.

Parameters

TRequestStatus & aRs
TUid aNotifierDllUid
TUid aNotifierUid
const TDesC8 & aBuffer
TDes8 & aResponse

UnloadNotifiers(TUid)

IMPORT_C TInt UnloadNotifiers ( TUid aNotifierUid )

This function has never been implemented on any Symbian OS version. It always returns KErrNotSupported.

Parameters

TUid aNotifierUid

UpdateNotifier(TUid, const TDesC8 &, TDes8 &)

IMPORT_C TInt UpdateNotifier ( TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

Requests the extended notifier server to update the active notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Parameters

TUid aNotifierUid The UID identifying the notifier.
const TDesC8 & aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
TDes8 & aResponse Reserved for future use.

UpdateNotifierAndGetResponse(TRequestStatus &, TUid, const TDesC8 &, TDes8 &)

IMPORT_C void UpdateNotifierAndGetResponse ( TRequestStatus & aRs,
TUid aNotifierUid,
const TDesC8 & aBuffer,
TDes8 & aResponse
)

Requests the extended notifier server to update the active notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

TRequestStatus & aRs The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
TUid aNotifierUid The UID identifying the notifier.
const TDesC8 & aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
TDes8 & aResponse Reserved for future use.

Member Data Documentation

TPtr8 iButtonVal

TPtr8 iButtonVal [private]

HBufC16 * iCombinedBuffer

HBufC16 * iCombinedBuffer [private]