locsrv_plat/supl_settings_api/inc/epos_csuplsettingparams.h
branchRCL_3
changeset 44 2b4ea9893b66
parent 0 667063e416a2
child 45 6b6920c56e2f
equal deleted inserted replaced
42:02ba3f1733c6 44:2b4ea9893b66
    46  *  - Timestamp ( when last used ).
    46  *  - Timestamp ( when last used ).
    47  *  - Timestamp ( when tried last ).
    47  *  - Timestamp ( when tried last ).
    48  *  - Network & Operator code ( when tried last ).
    48  *  - Network & Operator code ( when tried last ).
    49  *  - Network & Operator code ( when last used successfully).
    49  *  - Network & Operator code ( when last used successfully).
    50  *  - Editable ( yes / no).
    50  *  - Editable ( yes / no).
       
    51  *	- Product Configuration - Indicates that server is configured by product team or configured by user. 
       
    52  *    
    51  *
    53  *
    52  *  From the abover properties, only following fieds can be changed by SUPL settings client:
    54  *  From the abover properties, only following fieds can be changed by SUPL settings client:
    53  *  - SLP address
    55  *  - SLP address
    54  *  - IAP / destination.
    56  *  - IAP / destination.
    55  *  - SLP enabled / disabled.
    57  *  - SLP enabled / disabled.
    56  *  - Remove SLP, when SIM change ( yes / no ).
    58  *  - Remove SLP, when SIM change ( yes / no ).
    57  *  - Usage in home network ( yes / no ).
    59  *  - Usage in home network ( yes / no ).
    58  *  - Editable ( yes / no).
    60  *  - Editable ( yes / no).
       
    61  *	- Product Configuration
    59  * 
    62  * 
    60  */
    63  */
    61 class CServerParams : public CBase 
    64 class CServerParams : public CBase 
    62 	{
    65 	{
    63     public:  // Constructors and destructor
    66     public:  // Constructors and destructor
   113      * used to access the HSLP over the internet.  This can have maximum size of 100 characters.
   116      * used to access the HSLP over the internet.  This can have maximum size of 100 characters.
   114      * @param [IN] aServerEnabled Inidcates whether server enabled or not
   117      * @param [IN] aServerEnabled Inidcates whether server enabled or not
   115      * @param [IN] aSimChangeRemove Inidcates whether this server entry needs to be deleted when SIM changes 
   118      * @param [IN] aSimChangeRemove Inidcates whether this server entry needs to be deleted when SIM changes 
   116      * @param [IN] aUsageInHomeNw Inidcates whether server can be used in the home network or not 
   119      * @param [IN] aUsageInHomeNw Inidcates whether server can be used in the home network or not 
   117      * @param [IN] aEditable Inidcates whether this server entry can be edited or not 
   120      * @param [IN] aEditable Inidcates whether this server entry can be edited or not 
   118      *
   121      * @param [IN] aSlpId,Id of server for which client has to modify properties of SLP.
   119      * @return following error codes 
   122      * @return following error codes 
   120      *      - KErrNone if successful
   123      *      - KErrNone if successful
   121      *      - KErrArgument if any of the argument is not in the specified range or values specified are not reset value
   124      *      - KErrArgument if any of the argument is not in the specified range or values specified are not reset value
   122      */
   125      */
   123 	IMPORT_C TInt Set(
   126 	IMPORT_C TInt Set(
   131                 );
   134                 );
   132 
   135 
   133 
   136 
   134     /**
   137     /**
   135      * Returns server parameters. 
   138      * Returns server parameters. 
   136      *
   139      * @param [IN] aSlpId,Id of server for which client has to retrive properties of SLP.
   137      * @param [OUT] aServerAddress Server address in string format 
   140      * @param [OUT] aServerAddress Server address in string format 
   138      * @param [OUT] aIapName The Internet Access Point Name refers to the access point which is 
   141      * @param [OUT] aIapName The Internet Access Point Name refers to the access point which is 
   139      * used to access the HSLP over the internet.  This can have maximum size of 100 characters.
   142      * used to access the HSLP over the internet.  This can have maximum size of 100 characters.
   140      * @param [OUT] aServerEnabled Inidcates whether server enabled or not
   143      * @param [OUT] aServerEnabled Inidcates whether server enabled or not
   141      * @param [OUT] aSimChangeRemove Inidcates whether this server entry needs to be deleted when SIM changes 
   144      * @param [OUT] aSimChangeRemove Inidcates whether this server entry needs to be deleted when SIM changes 
   142      * @param [OUT] aUsageInHomeNw Inidcates whether server can be used in the home network or not 
   145      * @param [OUT] aUsageInHomeNw Inidcates whether server can be used in the home network or not 
   143      * @param [OUT] aEditable Inidcates whether this server entry can be edited or not 
   146      * @param [OUT] aEditable Inidcates whether this server entry can be edited or not 
   144      *
   147      * 
   145      * @return following error codes
   148      * @return following error codes
   146      *      - KErrNone if successful
   149      *      - KErrNone if successful
   147      *      - KErrNotFound if all of the parameters has reset value 
   150      *      - KErrNotFound if all of the parameters has reset value 
   148      */
   151      */
   149 	IMPORT_C TInt Get(
   152 	IMPORT_C TInt Get(
   153                 TBool& aServerEnabled,
   156                 TBool& aServerEnabled,
   154                 TBool& aSimChangeRemove,
   157                 TBool& aSimChangeRemove,
   155                 TBool& aUsageInHomeNw,
   158                 TBool& aUsageInHomeNw,
   156                 TBool& aEditable
   159                 TBool& aEditable
   157                 ) const;
   160                 ) const;
       
   161                 
       
   162 
       
   163     /**
       
   164      * Sets server parameters.  
       
   165      * @param [IN] aConfigurationType, Set ETrue to indicates that server is configured by product,
       
   166      * 																 		 EFalse to indicates that server is configured by user
       
   167      *
       
   168      * @return following error codes 
       
   169      *      - KErrNone if successful
       
   170      *			- Otherwise system wide error code
       
   171      */
       
   172 	IMPORT_C void SetServerConfigurationType(TBool aProductConfiguration);
       
   173 
       
   174 
       
   175     /**
       
   176      * Gets server parameters.  
       
   177      * @param [OUT] aConfigurationType, ETrue  indicates that server is configured by product,
       
   178      * 																  EFalse indicates that server is configured by user
       
   179      *
       
   180      * @return following error codes 
       
   181      *      - KErrNone if successful
       
   182      *			- KErrNotFound if server configuration property is not set.
       
   183      */
       
   184 	IMPORT_C TInt GetServerConfigurationType(TBool& aProductConfiguration) const;
       
   185 
       
   186 
   158 
   187 
   159 private:
   188 private:
   160     TInt64 iSlpId;
   189     TInt64 iSlpId;
   161     HBufC* iServerAddress;
   190     HBufC* iServerAddress;
   162     HBufC* iIap;
   191     HBufC* iIap;
   163     TBool iServerEnabled;
   192     TBool iServerEnabled;
   164     TBool iSimChangeRemove;
   193     TBool iSimChangeRemove;
   165     TBool iUsageInHomeNw;
   194     TBool iUsageInHomeNw;
   166     TBool iEditable;
   195     TBool iEditable;
       
   196     TBool iProductConfigured;
   167     
   197     
   168     //To indicate if the values were set using the Set method 
   198     //To indicate if the values were set using the Set method 
   169     TBool iIsValueSet;
   199     TBool iIsValueSet;
       
   200     
   170 	};
   201 	};
   171 
   202 
   172 /**
   203 /**
   173  * This class is used to retrieve the active trigger session information.  The required memory for
   204  * This class is used to retrieve the active trigger session information.  The required memory for
   174  * the parameters will be allocated during construction of this class and this class owns
   205  * the parameters will be allocated during construction of this class and this class owns
   326                       TTriggerType& aTriggerType,
   357                       TTriggerType& aTriggerType,
   327                       TRequestType& aRequestType,
   358                       TRequestType& aRequestType,
   328                       TUint64&  aOutstandingTrigger,
   359                       TUint64&  aOutstandingTrigger,
   329                       TUint64&  aInterval
   360                       TUint64&  aInterval
   330                     ) const;     
   361                     ) const;     
   331 
   362                     
       
   363 /**
       
   364      * Sets trigger parameters. 
       
   365      *
       
   366      * @since S60 5.2
       
   367      * @param [IN]  aEndTime Inidcates end time for triggering session.  This is valid only 
       
   368      * 						 if the trigger type is periodic triggers.
       
   369      * @return following error codes
       
   370      *      - KErrNone if successful
       
   371      *		- KErrNotFound if Session id specified is not running as periodic triggering session.
       
   372      */
       
   373      
       
   374 	IMPORT_C void SetTriggerEndTime(const TTime aEndTime);                  
       
   375 	
       
   376 	/**
       
   377      * Gets trigger parameters. 
       
   378      *
       
   379      * @since S60 5.2
       
   380      * @param [OUT] aEndTime Inidcates end time for triggering session.  This is valid only 
       
   381      * 						 if the trigger type is periodic triggers.
       
   382      * @return following error codes
       
   383      *      - KErrNone if successful
       
   384      *      - KErrArgument if Session id is not in the specified range
       
   385      *			- KErrNotFound if Session id specified is not running as periodic triggering session.
       
   386      */
       
   387      
       
   388 	IMPORT_C TInt GetTriggerEndTime(TTime& aEndTime)const ;                  
       
   389 
       
   390     
   332 
   391 
   333 private:
   392 private:
   334     TInt64 iSessionId;
   393     TInt64 iSessionId;
   335     HBufC* iSessionName;
   394     HBufC* iSessionName;
   336     TBool iNotificationPresent;
   395     TBool iNotificationPresent;
   337     TBool iTriggerNotificationStatus;
   396     TBool iTriggerNotificationStatus;
   338     TTriggerType iTriggerType;
   397     TTriggerType iTriggerType;
   339     TRequestType iRequestType;
   398     TRequestType iRequestType;
   340     TUint64 iOutstandingTrigger;
   399     TUint64 iOutstandingTrigger;
   341     TUint64 iInterval;
   400     TUint64 iInterval;
       
   401     TTime   iEndTime;
   342     //To indicate if the values were set using the Set method 
   402     //To indicate if the values were set using the Set method 
   343     TBool iIsValueSet;
   403     TBool iIsValueSet;
   344     };
   404     };
   345 #endif /* __EPOS_CSUPLSETTINGPARAMS_H__ */
   405 #endif /* __EPOS_CSUPLSETTINGPARAMS_H__ */