MProEngNotifyHandler Class Reference

API published in: S60 3rd Ed FP 1

Link against: profileengine.lib

Capability Information

Required Capabilities

WriteDeviceData

Exceptions

No capabilities needed for reading profiles.

#include <mproengnotifyhandler.h>

Detailed Description

Profiles change notification handler.

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


Public Member Functions
virtual TInt  RequestProfileActivationNotificationsL (MProEngProfileActivationObserver &aObserver)=0
  Request notifications of profile activations.
virtual TInt  RequestActiveProfileNotificationsL (MProEngActiveProfileObserver &aObserver)=0
  Request notifications of active profile modifications.
virtual TInt  RequestProfileNotificationsL (MProEngProfileObserver &aObserver, TInt aProfileId)=0
  Request notifications about changes in the given profile.
virtual TInt  RequestProfileNameArrayNotificationsL (MProEngProfileNameArrayObserver &aObserver)=0
  Request notifications about changes in the profile name array.
virtual void  CancelProfileActivationNotifications ()=0
  Cancel the registration for receiving notifications about profile activation events.
virtual void  CancelActiveProfileNotifications ()=0
  Cancel the registration for receiving notifications about the active profile modification events.
virtual void  CancelProfileNotifications (TInt aProfileId)=0
  Cancel the registration for receiving notifications about the given profile modification events.
virtual void  CancelProfileNameArrayNotifications ()=0
  Cancel the registration for receiving notifications about the changes in the profile name array.
virtual void  CancelAll ()=0
  Cancel all the registrations for receiving notifications.
virtual  ~MProEngNotifyHandler ()
  Destructor.

Constructor & Destructor Documentation

virtual MProEngNotifyHandler::~MProEngNotifyHandler (   )  [inline, virtual]
 

Destructor.

Member Function Documentation

virtual void MProEngNotifyHandler::CancelActiveProfileNotifications (   )  [pure virtual]
 

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

virtual void MProEngNotifyHandler::CancelAll (   )  [pure virtual]
 

Cancel all the registrations for receiving notifications.

virtual void MProEngNotifyHandler::CancelProfileActivationNotifications (   )  [pure virtual]
 

Cancel the registration for receiving notifications about profile activation events.

virtual void MProEngNotifyHandler::CancelProfileNameArrayNotifications (   )  [pure virtual]
 

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

virtual void MProEngNotifyHandler::CancelProfileNotifications (  TInt  aProfileId  )  [pure virtual]
 

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

Parameters:
aProfileId  The ID of the profile for which the client wants to cancel the receiving of modification events.
virtual TInt MProEngNotifyHandler::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.

Parameters:
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.
virtual TInt MProEngNotifyHandler::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.

Parameters:
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.
virtual TInt MProEngNotifyHandler::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.

Parameters:
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.
virtual TInt MProEngNotifyHandler::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.

Parameters:
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.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top