S60 3rd Edition API Reference: MSIPProfileRegistryObserver Class Reference

MSIPProfileRegistryObserver Class Reference

API published in: S60 2nd Ed

Link against: sipprofilecli.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData ReadUserData WriteDeviceData


#include <sipprofileregistryobserver.h>

Detailed Description

PublishedAll
Released
The observer class for monitoring SIP profiles. Class must be implemented by the user in order to observe changes in the SIP profiles.

Public Types

enum  TEvent {
  EProfileCreated = 0, EProfileUpdated, EProfileRegistered, EProfileDeregistered,
  EProfileDestroyed
}
 Profile Registry events. More...

Public Member Functions

virtual void ProfileRegistryEventOccurred (TUint32 aProfileId, TEvent aEvent)=0
 An event related to SIP Profile has accorred.
virtual void ProfileRegistryErrorOccurred (TUint32 aProfileId, TInt aError)=0
 An asynchronous error has occurred related to SIP profile Event is send to those observers, who have the corresponding profile instantiated.

Member Enumeration Documentation

enum MSIPProfileRegistryObserver::TEvent
 

Profile Registry events.

Enumerator:
EProfileCreated  Signals the creation of a SIP profile, indicating that a new profile is added into permanent store.

This event is sent to all observers.

EProfileUpdated  Signals the updating of a SIP profile, indicating that the data of an existing profile is updated into permanent store.

This event is sent to those observers who have the corresponding profile instantiated. Newly updated values of the profile are available for clients after they receive this signal.If profile was registered while updated, reregistration of the profile may occur. Updated values of the profile are uploaded into network when SIP registration process is completed.It is possible (but not recommended) that profile is updated even when it is being enabled by the client. If client receives this event for enabled profile, client should react as if error was occurred in the exception that profile is disabled or deleted first.

EProfileRegistered  Signals the changing of the registration status of a SIP profile to registered.

This event is sent to those observers who have the corresponding profile instantiated.

EProfileDeregistered  Signals the changing of the registration status of a SIP profile to deregistered.

This event is sent to those observers who have the corresponding profile instantiated.

EProfileDestroyed  Signals the destruction of a SIP profile, indicating that the profile has been removed from the permanent store and cannot be used anymore.This event is sent to those observers who have the corresponding profile instantiated.

Member Function Documentation

virtual void MSIPProfileRegistryObserver::ProfileRegistryErrorOccurred TUint32  aProfileId,
TInt  aError
[pure virtual]
 

An asynchronous error has occurred related to SIP profile Event is send to those observers, who have the corresponding profile instantiated.

Parameters:
aProfileId the id of failed profile
aError an occurred error
virtual void MSIPProfileRegistryObserver::ProfileRegistryEventOccurred TUint32  aProfileId,
TEvent  aEvent
[pure virtual]
 

An event related to SIP Profile has accorred.

Parameters:
aProfileId a profile Id
aEvent an occurred event

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

Copyright © Nokia Corporation 2001-2007
Back to top