MProEngNotifyHandler Class Reference

#include <mw/MProEngNotifyHandler.h>

Link against: ProfileEngine.lib

class MProEngNotifyHandler

Public Member Functions
virtual	~MProEngNotifyHandler()
pure virtual void	CancelActiveProfileNotifications()
pure virtual void	CancelAll()
pure virtual void	CancelProfileActivationNotifications()
pure virtual void	CancelProfileNameArrayNotifications()
pure virtual void	CancelProfileNotifications(TInt)
pure virtual TInt	RequestActiveProfileNotificationsL(MProEngActiveProfileObserver &)
pure virtual TInt	RequestProfileActivationNotificationsL(MProEngProfileActivationObserver &)
pure virtual TInt	RequestProfileNameArrayNotificationsL(MProEngProfileNameArrayObserver &)
pure virtual TInt	RequestProfileNotificationsL(MProEngProfileObserver &, TInt)

Detailed Description

Profiles change notification handler. This class is used for registration to get notifications about changes in Profiles data.

Since: S60 3.1

Constructor & Destructor Documentation

~MProEngNotifyHandler ( )

~MProEngNotifyHandler

(

)

[inline, virtual]

Destructor.

Member Function Documentation

CancelActiveProfileNotifications ( )

void

CancelActiveProfileNotifications

(

)

[pure virtual]

Cancel the registration for receiving notifications about the active profile modification events.

Since: S60 3.1

CancelAll ( )

void

CancelAll

(

)

[pure virtual]

Cancel all the registrations for receiving notifications.

Since: Series 60 3.1

CancelProfileActivationNotifications ( )

void

CancelProfileActivationNotifications

(

)

[pure virtual]

Cancel the registration for receiving notifications about profile activation events.

Since: S60 3.1

CancelProfileNameArrayNotifications ( )

void

CancelProfileNameArrayNotifications

(

)

[pure virtual]

Cancel the registration for receiving notifications about the changes in the profile name array.

Since: S60 3.1

CancelProfileNotifications ( TInt )

void

CancelProfileNotifications

(

TInt

aProfileId

)

[pure virtual]

Cancel the registration for receiving notifications about the given profile modification events.

Since: S60 3.1

Parameter	Description
aProfileId	The ID of the profile for which the client wants to cancel the receiving of modification events.

RequestActiveProfileNotificationsL ( MProEngActiveProfileObserver & )

TInt

RequestActiveProfileNotificationsL

(

MProEngActiveProfileObserver &

aObserver

)

[pure virtual]

Request notifications of active profile modifications. The notifications are received as long as CancelActiveProfileNotifications() or CancelAll() is called. If the client wants to change the observer, he should first cancel these notifications and then re-request them with the new observer instance.

Since: S60 3.1

Parameter	Description
aObserver	Reference to the observer to be notified in the event of active profile modification.

Returns: KErrNone if succesful, KErrAlreadyExists if this notification handler is already used for requesting active profile notifications. In other cases another system wide error code.

RequestProfileActivationNotificationsL ( MProEngProfileActivationObserver & )

TInt

RequestProfileActivationNotificationsL

(

MProEngProfileActivationObserver &

aObserver

)

[pure virtual]

Request notifications of profile activations. The notifications are received as long as CancelProfileActivationNotifications() or CancelAll() is called. If the client wants to change the observer, he should first cancel these notifications and then re-request them with the new observer instance.

Since: S60 3.1

Parameter	Description
aObserver	Reference to the observer to be notified in the event of profile activation.

Returns: KErrNone if succesful, KErrAlreadyExists if this notification handler is already used for requesting profile activation notifications. In other cases another system wide error code.

RequestProfileNameArrayNotificationsL ( MProEngProfileNameArrayObserver & )

TInt

RequestProfileNameArrayNotificationsL

(

MProEngProfileNameArrayObserver &

aObserver

)

[pure virtual]

Request notifications about changes in the profile name array. This includes the cases when: a new profile has been created, a profile has been deleted, the name of a profile has been changed. The notifications are received as long as CancelProfileNameArrayNotifications() or CancelAll() is called. If the client wants to change the observer, he should first cancel these notifications and then re-request them with the new observer instance.

Since: S60 3.1

Parameter	Description
aObserver	Reference to the observer to be notified in the event of a profile name array modification.

Returns: KErrNone if succesful, KErrAlreadyExists if this notification handler is already used for requesting profile name array notifications. In other cases another system wide error code.

RequestProfileNotificationsL ( MProEngProfileObserver &, TInt )

TInt	RequestProfileNotificationsL	(	MProEngProfileObserver &	aObserver,
			TInt	aProfileId
		)	[pure virtual]

Request notifications about changes in the given profile. This is useful for cases when the client is interested about changes in a specific profile no matter if the profile is active or not. The notifications are received as long as CancelProfileNotifications() or CancelAll() is called. If the client wants to change the observer for the notifications about the same profile, he should first cancel these notifications and then re-request them with the new observer instance.

Since: S60 3.1

Parameter	Description
aObserver	Reference to the observer to be notified in the event of modification of the specified profile.
aProfileId	the ID of the profile the changes of which has to be notified.

Returns: KErrNone if succesful, KErrAlreadyExists if this notification handler is already used for requesting notifications of changes in the given profile. KErrNotFound, if a profile with the given ID does not exist. In other cases another system wide error code.