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