RNotifier Class Reference

#include <e32std.h>

class RNotifier : public RSessionBase

Inherits from

Public Member Functions
RNotifier()
IMPORT_C TIntCancelNotifier(TUid)
IMPORT_C voidClose()
IMPORT_C TIntConnect()
IMPORT_C TIntInfoPrint(const TDesC &)
IMPORT_C TIntLoadNotifiers(TUid)
IMPORT_C voidNotify(const TDesC &, const TDesC &, const TDesC &, const TDesC &, TInt &, TRequestStatus &)
IMPORT_C voidNotifyCancel()
IMPORT_C TIntStartNotifier(TUid, const TDesC8 &)
IMPORT_C TIntStartNotifier(TUid, const TDesC8 &, TDes8 &)
IMPORT_C TIntStartNotifier(TUid, TUid, const TDesC8 &, TDes8 &)
IMPORT_C voidStartNotifierAndGetResponse(TRequestStatus &, TUid, const TDesC8 &, TDes8 &)
IMPORT_C voidStartNotifierAndGetResponse(TRequestStatus &, TUid, TUid, const TDesC8 &, TDes8 &)
IMPORT_C TIntUnloadNotifiers(TUid)
IMPORT_C TIntUpdateNotifier(TUid, const TDesC8 &, TDes8 &)
IMPORT_C voidUpdateNotifierAndGetResponse(TRequestStatus &, TUid, const TDesC8 &, TDes8 &)
Inherited Attributes
RHandleBase::iHandle
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
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()

Detailed Description

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.

Constructor & Destructor Documentation

RNotifier ( )

IMPORT_CRNotifier()

Default constructor.

Member Function Documentation

CancelNotifier ( TUid )

IMPORT_C TIntCancelNotifier(TUidaNotifierUid)

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
aNotifierUidThe UID identifying the notifier.
Return Value
KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

Close ( )

IMPORT_C voidClose()

Reimplemented from RHandleBase::Close()

Closes the notifier.

Connect ( )

IMPORT_C TIntConnect()

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.

Return Value
KErrNone, if successful, otherwise one of the other system-wide error codes

InfoPrint ( const TDesC & )

IMPORT_C TIntInfoPrint(const TDesC &aDes)

LoadNotifiers ( TUid )

IMPORT_C TIntLoadNotifiers(TUidaNotifierUid)

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

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

IMPORT_C voidNotify(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
aLine1A descriptor containing the first line of text to be displayed.
aLine2A descriptor containing the second line of text to be displayed.
aBut1A descriptor containing text to be displayed in the first button.
aBut2A descriptor containing text to be displayed in the (optional) second button.
aButtonValAn 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.
aStatusThe request status object. If the request completes normally, this is set to KErrNone.

NotifyCancel ( )

IMPORT_C voidNotifyCancel()

Not implemented by the server.

StartNotifier ( TUid, const TDesC8 & )

IMPORT_C TIntStartNotifier(TUidaNotifierUid,
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.

See also: CServer

Parameters
aNotifierUidThe UID identifying the notifier.
aBufferData that can be passed to the notifier; the format and meaning of this depends on the notifier.
Return Value
KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID; KErrAlreadyExists, if the notifier has already been started, or has an outstanding start request. It may also return with one of the other system-wide error codes, if the notifier cannot be started by the server due to low memory or it leaves from its server side call to StartL().

StartNotifier ( TUid, const TDesC8 &, TDes8 & )

IMPORT_C TIntStartNotifier(TUidaNotifierUid,
const TDesC8 &aBuffer,
TDes8 &aResponse
)
Deprecated

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().

See also: CServer

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

Parameters
aNotifierUidThe UID identifying the notifier.
aBufferData that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponseResponse data; the format and meaning of this depends on the notifier.
Return Value
KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID; KErrAlreadyExists, if the notifier has already been started, or has an outstanding start request. It may also return with one of the other system-wide error codes, if the notifier cannot be started by the server due to low memory or it leaves from its server side call to StartL().

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

IMPORT_C TIntStartNotifier(TUidaNotifierDllUid,
TUidaNotifierUid,
const TDesC8 &aBuffer,
TDes8 &aResponse
)

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

IMPORT_C voidStartNotifierAndGetResponse(TRequestStatus &aRs,
TUidaNotifierUid,
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
aRsThe request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
aNotifierUidThe UID identifying the notifier.
aBufferData that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponseResponse data; the format and meaning of this depends on the notifier.

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

IMPORT_C voidStartNotifierAndGetResponse(TRequestStatus &aRs,
TUidaNotifierDllUid,
TUidaNotifierUid,
const TDesC8 &aBuffer,
TDes8 &aResponse
)

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

UnloadNotifiers ( TUid )

IMPORT_C TIntUnloadNotifiers(TUidaNotifierUid)

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

UpdateNotifier ( TUid, const TDesC8 &, TDes8 & )

IMPORT_C TIntUpdateNotifier(TUidaNotifierUid,
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
aNotifierUidThe UID identifying the notifier.
aBufferData that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponseReserved for future use.
Return Value
KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

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

IMPORT_C voidUpdateNotifierAndGetResponse(TRequestStatus &aRs,
TUidaNotifierUid,
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
aRsThe request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
aNotifierUidThe UID identifying the notifier.
aBufferData that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponseReserved for future use.