Class RNotifier

RNotifier

Support

Supported from 5.0

Description

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

Prior to 6.0, the notifier server provides access to a simple built-in notifier and does not support plug-in notifiers.

Derivation

RHandleBase Handle to an object RNotifier A handle to a session with the extended notifier server that provides support for plug-in notifiers RSessionBase Client-side handle to a session with a server

Defined in RNotifier:
CancelNotifier(), Connect(), InfoPrint(), Notify(), RNotifier(), StartNotifier(), StartNotifierAndGetResponse(), UpdateNotifier()

Inherited from RHandleBase:
Close(), Duplicate(), Handle(), SetHandle()

Inherited from RSessionBase:
Attach(), CreateSession(), EAutoAttach, EExplicitAttach, Send(), SendReceive(), SetRetry(), Share(), TAttachMode

See also:

• RHandleBase::Close()

RNotifier();

Description

Constructs an empty notifier object.

TInt Connect();

Description

Connects to the extended notifier server, creating a session with that server.

The server is started , if it is not already running. Starting the server causes it to load the plug-in DLLs that define and implement notifiers.

Prior to 6.0, the notifier server provides access to a simple built-in notifier and does not support plug-in notifiers.

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes:

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

Support

Supported from 6.0

Description

Requests the extended notifier server to start the plug-in 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 plug-in notifier. const TDesC8& aBuffer Data that can be passed to the plug-in notifier. The format and meaning of this depends on the notifier. TDes8& aResponse Data that can be returned by the plug-in notifier. The format and meaning of this depends on the plug-in notifier.

Return value

TInt KErrNotFound, if there is no plug-in notifier matching the specified UID.

TInt CancelNotifier(TUid aNotifierUid);

Support

Supported from 6.0

Description

Requests the extended notifier server to cancel the plug-in 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 plug-in notifier.

Return value

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

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

Support

Supported from 6.0

Description

Requests the extended notifier server to update the plug-in 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 plug-in notifier. const TDesC8& aBuffer Data that can be passed to the plug-in notifier. The format and meaning of this depends on the plug-in notifier. TDes8& aResponse Data that can be returned by the plug-in notifier. The format and meaning of this depends on the plug-in notifier.

Return value

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

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

Support

Supported from 6.0

Description

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

This is an asynchronous request.

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 plug-in notifier. const TDesC8& aBuffer Data that can be passed to the plug-in notifier. The format and meaning of this depends on the plug-in notifier. TDes8& aResponse Data that can be returned by the plug-in notifier. The format and meaning of this depends on the plug-in notifier.

TInt InfoPrint(const TDesC& aDes);

Description

Displays a single line message, synchronously.

This function does not use the plug-in notifier framework.

Parameters

const TDesC& aDes The descriptor containing the text of the message to be displayed.

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes:

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

Description

Displays a simple dialog box, asynchronously.

The descriptors aLine1 and aLine2 contain the text to be displayed as the first and second lines respectively. The descriptors aBut1 and aBut2 contain the characters to be displayed on the first and second buttons respectively.

aButtonVal is a reference to a TInt passed by the caller which is set when the notify request completes (when the user selects one or other of the buttons). The value is set to 0, if the first button is selected or 1, if the second button is selected.

aLine1 and aLine2 can be empty descriptors (i.e. zero length); aBut1 and aBut2 must have at least one character, but however many characters are passed, only the first character is used.

Note:

• The descriptors aLine1, aLine2, aBut1 and aBut2 must remain in existence until the notify request completes.

This function does not use the plug-in notifier framework.

Parameters

const TDesC& aLine1 A reference to descriptor containing the first line of text to be displayed. const TDesC& aLine2 A reference to descriptor containing the second line of text to be displayed. const TDesC& aBut1 A reference to descriptor containing the first button character. const TDesC& aBut2 A reference to descriptor containing the second button character. TInt& aButtonVal A reference to an integer value which is set to: 0, if the first button is selected1, if the second button is selected. TRequestStatus& aStatus A reference to the request status object. If the request completes normally, this is set to KErrNone.