commsconfig/cscsipvoipcleanupplugin/inc/cscsvcpluginsiphandler.h
changeset 0 a4daefaec16c
equal deleted inserted replaced
-1:000000000000 0:a4daefaec16c
       
     1 /*
       
     2 * Copyright (c) 2007-2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CSCSVCPLUGINSIPHANDLER_H
       
    20 #define C_CSCSVCPLUGINSIPHANDLER_H
       
    21 
       
    22 
       
    23 #include <e32base.h>
       
    24 #include <sipprofileregistryobserver.h>
       
    25 
       
    26 class CSIPManagedProfile;
       
    27 class CSIPManagedProfileRegistry;
       
    28 
       
    29 
       
    30 /**
       
    31  *  CCSCSvcPluginSipHandler class
       
    32  *
       
    33  *  @lib
       
    34  *  @since S60 v3.2
       
    35  */
       
    36 class CCSCSvcPluginSipHandler : public CBase,
       
    37                                 public MSIPProfileRegistryObserver
       
    38     {
       
    39     public:
       
    40 
       
    41         static CCSCSvcPluginSipHandler* NewL();
       
    42         
       
    43         /**
       
    44          * Destructor.
       
    45          */
       
    46         ~CCSCSvcPluginSipHandler();
       
    47 
       
    48                     
       
    49         /**
       
    50          * Sets SIP setting registration mode.
       
    51          * Function leaves on failure.
       
    52          *
       
    53          * @since S60 v3.2
       
    54          * @param aId for SIP profile id
       
    55          * @param aRegMode SIP registration mode
       
    56          */
       
    57         void SetRegistrationModeL( TUint32 aId, TBool aRegMode );
       
    58 
       
    59         
       
    60         /**
       
    61          * Gets SIP profile access point Id.
       
    62          * Function leaves on failure.
       
    63          *
       
    64          * @since S60 v3.2
       
    65          * @param aId for SIP profile id
       
    66          * @param aApId Access point Id
       
    67          */
       
    68         void GetApIdL( TUint32 aId,  TUint32& aApId );
       
    69 
       
    70         /**
       
    71          * Gets SIP profile user's address-of-record.
       
    72          * Function leaves on failure.
       
    73          *
       
    74          * @since S60 v3.2
       
    75          * @param aId for SIP profile id
       
    76          * @param aUserAor user's address-of-record
       
    77          */
       
    78         void GetUserAorL( TUint32 aId,  TDes8& aUserAor );
       
    79         
       
    80         /**
       
    81          * Destroys SIP profile from SIP Stack based on SIP profile id.
       
    82          * Function leaves on failure.
       
    83          *
       
    84          * @since S60 v3.2
       
    85          * @param aProfileId for SIP profile id to be deleted
       
    86          */
       
    87         void RemoveProfileL( TUint32 aProfileId );
       
    88 
       
    89 
       
    90         // from base class MSIPProfileRegistryObserver
       
    91     
       
    92         /** 
       
    93          * From MSIPProfileRegistryObserver 
       
    94          * SIP profile information event.
       
    95          *
       
    96          * @since S60 v3.0
       
    97          * @param aProfileId is id for profile
       
    98          * @param aEvent type of information event
       
    99          */
       
   100         void ProfileRegistryEventOccurred(
       
   101             TUint32 aSIPProfileId, 
       
   102             TEvent aEvent );
       
   103 
       
   104         
       
   105         /**
       
   106          * From MSIPProfileRegistryObserver
       
   107          * An asynchronous error has occurred related to SIP profile.
       
   108          *
       
   109          * @since S60 v3.0
       
   110          * @param aSIPProfileId the id of failed profile 
       
   111          * @param aError a error code
       
   112          */
       
   113         void ProfileRegistryErrorOccurred(
       
   114             TUint32 aSIPProfileId,
       
   115             TInt aError );
       
   116   
       
   117 
       
   118     private:
       
   119          
       
   120         CCSCSvcPluginSipHandler();
       
   121 
       
   122         void ConstructL();
       
   123 
       
   124     private: // data
       
   125     
       
   126         /*
       
   127          * Handle to SIP managed profile registry.
       
   128          * Own.
       
   129          */
       
   130         CSIPManagedProfileRegistry* iSipProfileRegistry;
       
   131     };
       
   132 
       
   133 #endif  // C_CSCSVCPLUGINSIPHANDLER_H
       
   134 
       
   135