MCenRepNotifyHandlerCallback Class Reference

API published in: S60 3rd Ed FP 1

Link against: cenrepnotifhandler.lib

Capability Information

Required Capabilities

None

Exceptions

Capability required depends on platform security of the repository.

#include <cenrepnotifyhandler.h>

Inherited by CEikEdwin::CEikEdwinExtension [private].

Detailed Description

Class provides a callback interface for handling the notifification events from the Central Repository.

The Client derives a class from this interface and implements the HandleNotify-methods that interest it. An empty default implementation is provided for all of the methods. In debug build the default implementations print out a debug trace.


Public Member Functions
virtual IMPORT_C void	HandleNotifyInt (TUint32 aId, TInt aNewValue)
	This callback method is used to notify the client about changes for integer value keys, i.e.
virtual IMPORT_C void	HandleNotifyReal (TUint32 aId, TReal aNewValue)
	This callback method is used to notify the client about changes for real value keys, i.e.
virtual IMPORT_C void	HandleNotifyString (TUint32 aId, const TDesC16 &aNewValue)
	This callback method is used to notify the client about changes for string value keys, i.e.
virtual IMPORT_C void	HandleNotifyBinary (TUint32 aId, const TDesC8 &aNewValue)
	This callback method is used to notify the client about changes for binary value keys, i.e.
virtual IMPORT_C void	HandleNotifyGeneric (TUint32 aId)
	This callback method is used to notify the client about changes in keys when the whole repository is listened for.
virtual IMPORT_C void	HandleNotifyError (TUint32 aId, TInt aError, CCenRepNotifyHandler *aHandler)
	This callback method is used to notify the client about errors in the handler.

Member Function Documentation

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyBinary	(	TUint32	aId,
		const TDesC8 &	aNewValue
	)	`[virtual]`

This callback method is used to notify the client about changes for binary value keys, i.e.

key type is EBinaryKey.

Parameters:

	aId	Id of the key that has changed.
	aNewValue	The new value of the key.

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyError	(	TUint32	aId,
		TInt	aError,
		CCenRepNotifyHandler *	aHandler
	)	`[virtual]`

This callback method is used to notify the client about errors in the handler.

Any error in handling causes the handler to stop handling any more notifications. Handling can be restarted with a call to aHandler->StartListeningL(), if the error is non-fatal. However, be careful to trap any errors from this call if this is done.

Parameters:

	aId	Id of the key this instance listens to or if notifications for whole repository are listened, could also be KInvalidNotificationId.
	aError	Error code.
	aHandler	Pointer to the handler instance. This pointer can be used to identify the handler or restart the listening.

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyGeneric ( TUint32 aId ) [virtual]

This callback method is used to notify the client about changes in keys when the whole repository is listened for.

Note: It is not guaranteed that a notification will be received for all keys, if multiple keys are changed in rapid succession by multiple threads or when the whole repository is reset, therefore only listen for whole repository if this is not an issue.

Parameters:

aId

Id of the key that has changed. If multiple keys were changed by whole repository reset, value will be KInvalidNotificationId.

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyInt	(	TUint32	aId,
		TInt	aNewValue
	)	`[virtual]`

This callback method is used to notify the client about changes for integer value keys, i.e.

key type is EIntKey.

Parameters:

	aId	Id of the key that has changed.
	aNewValue	The new value of the key.

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyReal	(	TUint32	aId,
		TReal	aNewValue
	)	`[virtual]`

This callback method is used to notify the client about changes for real value keys, i.e.

key type is ERealKey.

Parameters:

	aId	Id of the key that has changed.
	aNewValue	The new value of the key.

virtual IMPORT_C void MCenRepNotifyHandlerCallback::HandleNotifyString	(	TUint32	aId,
		const TDesC16 &	aNewValue
	)	`[virtual]`

This callback method is used to notify the client about changes for string value keys, i.e.

key type is EStringKey.

Parameters:

	aId	Id of the key that has changed.
	aNewValue	The new value of the key.

The documentation for this class was generated from the following file:

cenrepnotifyhandler.h

MCenRepNotifyHandlerCallback Class Reference

Capability Information

Detailed Description

Public Member Functions

Member Function Documentation