epoc32/include/sipprofileregistryobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/sipprofileregistryobserver.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/sipprofileregistryobserver.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,120 @@
-sipprofileregistryobserver.h
+/*
+* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* 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
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+* Name        : sipprofileregistryobserver.h
+* Part of     : SIP Profile Client
+* Interface   : SDK API, SIP Profile API
+* The observer class for monitoring SIP profiles.
+* Version     : 1.0
+*
+*/
+
+
+
+#ifndef MSIPPROFILEOREGISTRYBSERVER_H
+#define MSIPPROFILEOREGISTRYBSERVER_H
+
+//  INCLUDES
+#include <e32base.h>
+#include <e32std.h>
+
+// FORWARD DECLARATIONS
+
+// CLASS DECLARATION
+/**
+*  @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.
+*/
+class MSIPProfileRegistryObserver 
+    {
+    public: 
+        /** Profile Registry events */
+        enum TEvent
+            {
+            /** 
+            * Signals the creation of a SIP profile, indicating that a new
+            * profile is added into permanent store. This event is sent to
+            * all observers.
+            */
+            EProfileCreated = 0,
+            /** 
+            * 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.
+            */
+            EProfileUpdated,
+            /**
+            * 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.
+            */
+            EProfileRegistered,
+            /**
+            * 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.
+            */
+            EProfileDeregistered,
+            /**
+            * 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.
+            */
+            EProfileDestroyed,
+            /**
+             * Signals the force disabling of a SIP profile, indicating that 
+             * all the users attached to the profile are detached. This event
+             * is sent to all the observers but ForceDisable API can be invoked
+			 * only by application with Network Control capability.
+             */
+            EProfileForciblyDisabled
+            };
+
+        /** 
+        * An event related to SIP Profile has accorred
+        * @param aProfileId a profile Id
+        * @param aEvent an occurred event
+        **/
+        virtual void ProfileRegistryEventOccurred(TUint32 aProfileId,
+                                                  TEvent aEvent)=0;
+
+        /**
+        * An asynchronous error has occurred related to SIP profile
+        * Event is send to those observers, who have the
+        * corresponding profile instantiated.
+        * @param aProfileId the id of failed profile 
+        * @param aError an occurred error
+        */
+        virtual void ProfileRegistryErrorOccurred(TUint32 aProfileId,
+                                                  TInt aError)=0;
+    };
+
+#endif // MSIPPROFILEOREGISTRYBSERVER_H