epoc32/include/sipprofileregistryobserver.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- a/epoc32/include/sipprofileregistryobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,120 +0,0 @@
     1.4 -/*
     1.5 -* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 -* All rights reserved.
     1.7 -* This component and the accompanying materials are made available
     1.8 -* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 -* which accompanies this distribution, and is available
    1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 -*
    1.12 -* Initial Contributors:
    1.13 -* Nokia Corporation - initial contribution.
    1.14 -*
    1.15 -* Contributors:
    1.16 -*
    1.17 -* Description:
    1.18 -* Name        : sipprofileregistryobserver.h
    1.19 -* Part of     : SIP Profile Client
    1.20 -* Interface   : SDK API, SIP Profile API
    1.21 -* The observer class for monitoring SIP profiles.
    1.22 -* Version     : 1.0
    1.23 -*
    1.24 -*/
    1.25 -
    1.26 -
    1.27 -
    1.28 -#ifndef MSIPPROFILEOREGISTRYBSERVER_H
    1.29 -#define MSIPPROFILEOREGISTRYBSERVER_H
    1.30 -
    1.31 -//  INCLUDES
    1.32 -#include <e32base.h>
    1.33 -#include <e32std.h>
    1.34 -
    1.35 -// FORWARD DECLARATIONS
    1.36 -
    1.37 -// CLASS DECLARATION
    1.38 -/**
    1.39 -*  @publishedAll
    1.40 -*  @released
    1.41 -*
    1.42 -*  The observer class for monitoring SIP profiles.
    1.43 -*  Class must be implemented by the user in order to 
    1.44 -*  observe changes in the SIP profiles.
    1.45 -*/
    1.46 -class MSIPProfileRegistryObserver 
    1.47 -    {
    1.48 -    public: 
    1.49 -        /** Profile Registry events */
    1.50 -        enum TEvent
    1.51 -            {
    1.52 -            /** 
    1.53 -            * Signals the creation of a SIP profile, indicating that a new
    1.54 -            * profile is added into permanent store. This event is sent to
    1.55 -            * all observers.
    1.56 -            */
    1.57 -            EProfileCreated = 0,
    1.58 -            /** 
    1.59 -            * Signals the updating of a SIP profile, indicating that the data of 
    1.60 -            * an existing profile is updated into permanent store. This event is
    1.61 -            * sent to those observers who have the corresponding profile 
    1.62 -            * instantiated. 
    1.63 -            * Newly updated values of the profile are available for clients after
    1.64 -            * they receive this signal.If profile was registered while updated,
    1.65 -            * reregistration of the profile may occur. Updated values of the 
    1.66 -            * profile are uploaded into network when SIP registration process
    1.67 -            * is completed.It is possible (but not recommended) that profile is
    1.68 -            * updated even when it is being enabled by the client. If client 
    1.69 -            * receives this event for enabled profile, client should react as if
    1.70 -            * error was occurred in the exception that profile is disabled
    1.71 -            * or deleted first.
    1.72 -            */
    1.73 -            EProfileUpdated,
    1.74 -            /**
    1.75 -            * Signals the changing of the registration status of a SIP profile
    1.76 -            * to registered.
    1.77 -            * This event is sent to those observers who have the corresponding
    1.78 -            * profile instantiated.
    1.79 -            */
    1.80 -            EProfileRegistered,
    1.81 -            /**
    1.82 -            * Signals the changing of the registration status of a SIP profile
    1.83 -            * to deregistered.
    1.84 -            * This event is sent to those observers who have the corresponding
    1.85 -            * profile instantiated.
    1.86 -            */
    1.87 -            EProfileDeregistered,
    1.88 -            /**
    1.89 -            * Signals the destruction of a SIP profile, indicating that the 
    1.90 -            * profile has been removed from the permanent store and cannot 
    1.91 -            * be used anymore.This event is sent to those observers who have 
    1.92 -            * the corresponding profile instantiated.
    1.93 -            */
    1.94 -            EProfileDestroyed,
    1.95 -            /**
    1.96 -             * Signals the force disabling of a SIP profile, indicating that 
    1.97 -             * all the users attached to the profile are detached. This event
    1.98 -             * is sent to all the observers but ForceDisable API can be invoked
    1.99 -			 * only by application with Network Control capability.
   1.100 -             */
   1.101 -            EProfileForciblyDisabled
   1.102 -            };
   1.103 -
   1.104 -        /** 
   1.105 -        * An event related to SIP Profile has accorred
   1.106 -        * @param aProfileId a profile Id
   1.107 -        * @param aEvent an occurred event
   1.108 -        **/
   1.109 -        virtual void ProfileRegistryEventOccurred(TUint32 aProfileId,
   1.110 -                                                  TEvent aEvent)=0;
   1.111 -
   1.112 -        /**
   1.113 -        * An asynchronous error has occurred related to SIP profile
   1.114 -        * Event is send to those observers, who have the
   1.115 -        * corresponding profile instantiated.
   1.116 -        * @param aProfileId the id of failed profile 
   1.117 -        * @param aError an occurred error
   1.118 -        */
   1.119 -        virtual void ProfileRegistryErrorOccurred(TUint32 aProfileId,
   1.120 -                                                  TInt aError)=0;
   1.121 -    };
   1.122 -
   1.123 -#endif // MSIPPROFILEOREGISTRYBSERVER_H