Class RNotifier

class RNotifier : public RSessionBase;

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.

Derivation

• RHandleBase - A handle to an object

• RSessionBase - Client-side handle to a session with a server

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

Members

Defined in RNotifier:
CancelNotifier(), Close(), Connect(), Notify(), NotifyCancel(), RNotifier(), StartNotifier(), StartNotifier(), StartNotifier(), StartNotifierAndGetResponse(), UpdateNotifier(), UpdateNotifierAndGetResponse()

Inherited from RHandleBase:
Attributes(), Duplicate(), FullName(), Handle(), HandleInfo(), Name(), SetHandle(), SetHandleNC(), iHandle

Inherited from RSessionBase:
CreateSession(), EAutoAttach, EExplicitAttach, Open(), Send(), SendReceive(), SetReturnedHandle(), ShareAuto(), ShareProtected(), TAttachMode

IMPORT_C RNotifier();

Description

Default constructor.

IMPORT_C TInt Connect();

Description

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

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

IMPORT_C void Close();

Description

Closes the notifier.

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

Description

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.

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.

Return value

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

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

Description

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

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.

Return value

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

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

Description

Parameters

TUid aNotifierDllUid TUid aNotifierUid const TDesC8 &aBuffer TDes8 &aResponse

Return value

TInt

IMPORT_C TInt CancelNotifier(TUid aNotifierUid);

Description

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.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

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

Description

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.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

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

Description

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.

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

Description

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.

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

Description

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.

IMPORT_C void NotifyCancel();

Description

Not implemented by the server.