1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipmanagedprofile.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,226 @@
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 : sipmanagedprofile.h
1.19 +* Part of : SIP Profile Client
1.20 +* Interface : SDK API, SIP Profile API
1.21 +* The class providing profile management of SIP service provider
1.22 +* Version : 1.0
1.23 +*
1.24 +*/
1.25 +
1.26 +
1.27 +
1.28 +#ifndef CSIPMANAGEDPROFILE_H
1.29 +#define CSIPMANAGEDPROFILE_H
1.30 +
1.31 +// INCLUDES
1.32 +
1.33 +#include <e32base.h>
1.34 +#include <e32std.h>
1.35 +#include <badesca.h>
1.36 +
1.37 +#include "sipprofile.h"
1.38 +
1.39 +//CONSTANTS
1.40 +
1.41 +/** SIP Provider Name which value is type of TDesC8.
1.42 +* Note that this parameter can only be retrieved
1.43 +* if it has been explicitly configured */
1.44 +const TUint32 KSIPPrivateIdentity = 500;
1.45 +
1.46 +/** SIP HTTP Digest password which value is type of TDesC8.
1.47 +* Note that this parameter cannot be retrieved */
1.48 +const TUint32 KSIPDigestPassword = 501;
1.49 +
1.50 +/**
1.51 +* SIP headers to be added to outgoing SIP requests generated
1.52 +* by SIP Profile Agent. The value is of type MDesC8Array.
1.53 +* Each array element represents a complete SIP header (name and value). */
1.54 +const TUint32 KSIPHeaders = 502;
1.55 +
1.56 +/**
1.57 +* Setting for enabling/disabling IMS registration with certain types of
1.58 +* smart card applications. The value is of type TUint32.
1.59 +* If no value for this setting is configured, registration is allowed
1.60 +* with all types of smart card applications (SIM/USIM/ISIM).
1.61 +* If the value is configured, the following values are possible:
1.62 +* 1: Registration is allowed only when USIM or ISIM is present.
1.63 +* 2: Registration is allowed only when ISIM present */
1.64 +const TUint32 KSIPAllowIMSRegistration = 503;
1.65 +
1.66 +/**
1.67 +* Setting for enabling/disabling editing the profile after its creation.
1.68 +* Serves as an indication for the clients that the profile
1.69 +* update and deletion operations are restricted.
1.70 +* The SIP Profile Agent implementation does not understand
1.71 +* the semantics of the parameter.
1.72 +* The value is of type TBool. */
1.73 +const TUint32 KSIPProfileLocked = 504;
1.74 +
1.75 +/**
1.76 +* Defines how autoregistration profile behaves on home network/roaming
1.77 +* situations. If value is ETrue, automatic registration is not allowed
1.78 +* while roaming.
1.79 +* The value is of type TBool. */
1.80 +const TUint32 KSIPAllowAutoRegistrationOnlyOnHomeNetwork = 505;
1.81 +
1.82 +// FORWARD DECLARATIONS
1.83 +
1.84 +class CSIPManagedProfileRegistry;
1.85 +
1.86 +
1.87 +// CLASS DECLARATION
1.88 +
1.89 +/**
1.90 +* @publishedAll
1.91 +* @released
1.92 +*
1.93 +* Class contains profile information of particular SIP service
1.94 +* provider. Class provides functions for setting and
1.95 +* getting profile parameters.
1.96 +*
1.97 +* @lib sipprofilecli.lib
1.98 +*/
1.99 +class CSIPManagedProfile: public CSIPProfile
1.100 + {
1.101 + public: // Constructors and destructor
1.102 + /**
1.103 + * Destructor.
1.104 + */
1.105 + IMPORT_C ~CSIPManagedProfile();
1.106 +
1.107 + public: // New functions
1.108 + /**
1.109 + * Sets profile type information;
1.110 + * @param aSIPProfileTypeInfo profile type information
1.111 + */
1.112 + IMPORT_C void SetType(const TSIPProfileTypeInfo& aSIPProfileTypeInfo);
1.113 +
1.114 + /**
1.115 + * Sets profile parameter
1.116 + * @param aParam a parameter to set; zero-length descriptor resets the value
1.117 + * @param aVal a value to set
1.118 + * @return KErrNotFound if parameter was not found,
1.119 + * KErrNoMemory if out of memory;
1.120 + * KErrNone otherwise
1.121 + */
1.122 + IMPORT_C TInt SetParameter(TUint32 aParam, const TDesC8& aVal);
1.123 +
1.124 + /**
1.125 + * Sets profile parameter
1.126 + * @param aParam a parameter to set
1.127 + * @param aVal a value to set
1.128 + * @return KErrNotFound if parameter was not found, KErrNone otherwise
1.129 + */
1.130 + IMPORT_C TInt SetParameter(TUint32 aParam, TUint32 aVal);
1.131 +
1.132 + /**
1.133 + * Sets profile parameter
1.134 + * @param aParam a parameter to set
1.135 + * @param aVal a value to set
1.136 + * @return KErrNotFound if parameter was not found, KErrNone otherwise
1.137 + */
1.138 + IMPORT_C TInt SetParameter(TUint32 aParam, TBool aVal);
1.139 +
1.140 + /**
1.141 + * Sets profile parameter
1.142 + * @param aParam a parameter to set
1.143 + * @param aVal values to set; an empty array resets the value
1.144 + * @return KErrNotFound if parameter was not found,
1.145 + * KErrNoMemory if out of memory
1.146 + * KErrNone otherwise
1.147 + */
1.148 + IMPORT_C TInt SetParameter(TUint32 aParam, const MDesC8Array& aVal);
1.149 +
1.150 + /**
1.151 + * Sets profile parameter that is defined for a particular SIP server
1.152 + * @param aServerType a SIP server type
1.153 + * @param aParam a parameter to set
1.154 + * @param aVal a value to set; zero-length descriptor resets the value
1.155 + * @return KErrNotFound if parameter was not found,
1.156 + * KErrNoMemory if out of memory;
1.157 + * KErrNone otherwise
1.158 + */
1.159 + IMPORT_C TInt SetParameter(TUint32 aServerType, TUint32 aParam, const TDesC8& aVal);
1.160 +
1.161 + /**
1.162 + * Creates deep copy of the object
1.163 + * @return deep copied instance
1.164 + * @leave KErrNoMemory if out of memory
1.165 + */
1.166 + IMPORT_C CSIPManagedProfile* CloneL() const;
1.167 +
1.168 + public:
1.169 + /**
1.170 + * Two-phased constructor.
1.171 + * @param aSIPRegistry a SIP profile client providing connection to SIP
1.172 + * profile server.
1.173 + */
1.174 + static CSIPManagedProfile* NewL(CSIPManagedProfileRegistry* aSIPRegistry);
1.175 +
1.176 + /**
1.177 + * Two-phased constructor.
1.178 + * @param aSIPRegistry a SIP profile client providing connection to SIP
1.179 + * profile server.
1.180 + * Constructs an object and adds the pointer to the cleanup stack;
1.181 + */
1.182 + static CSIPManagedProfile* NewLC(CSIPManagedProfileRegistry* aSIPRegistry);
1.183 +
1.184 + private:
1.185 +
1.186 + /**
1.187 + * Constructor.
1.188 + */
1.189 + CSIPManagedProfile(CSIPManagedProfileRegistry* aSIPRegistry);
1.190 +
1.191 + /**
1.192 + * Sets profile parameter
1.193 + * @param aParam a parameter to set; zero-length descriptor resets the value
1.194 + * @param aVal a value to set
1.195 + */
1.196 + void SetParameterL(TUint32 aParam, const TDesC8& aVal);
1.197 +
1.198 + /**
1.199 + * Sets profile parameter
1.200 + * @param aParam a parameter to set
1.201 + * @param aVal a value to set
1.202 + */
1.203 + void SetParameterL(TUint32 aParam, TUint32 aVal);
1.204 +
1.205 + /**
1.206 + * Sets profile parameter
1.207 + * @param aParam a parameter to set
1.208 + * @param aVal a value to set
1.209 + */
1.210 + void SetParameterL(TUint32 aParam, TBool aVal);
1.211 +
1.212 + /**
1.213 + * Sets profile parameter that is defined for a particular SIP server
1.214 + * @param aServerType a SIP server type
1.215 + * @param aParam a parameter to set
1.216 + * @param aVal a value to set; zero-length descriptor resets the value
1.217 + */
1.218 + void SetParameterL(TUint32 aServerType,
1.219 + TUint32 aParam, const TDesC8& aVal);
1.220 +
1.221 + /**
1.222 + * Sets profile parameter
1.223 + * @param aParam a parameter to set
1.224 + * @param aVal values to set; an empty array resets the value
1.225 + */
1.226 + IMPORT_C void SetParameterL(TUint32 aParam, const MDesC8Array& aVal);
1.227 + };
1.228 +
1.229 +#endif // CSIPMANAGEDPROFILE_H