FCL/sf/mw/locationsrv: comparison locsrv_plat/supl_settings_api/inc/epos

equal deleted inserted replaced

-:02ba3f1733c6
+:2b4ea9893b66
 /** Indicates that SUPL can be used without asking user in the home network and
 * user should be notified in the visiting network */
 ESuplUsageHomeAutomatic,
 /** Indicates that SUPL usage is disabled */
 ESuplUsageDisabled
 };
+/**
+* Enumeration to indicate status of SUPL triggered service.  This is used as parameter for
+* @ref ChangeSuplTriggerServiceStatus() and @ref GetSuplTriggerServiceStatus() method. Client has to select one of the values from
+	     * this enumeration when changing SUPL triggered service status.
+	     * For example, if client is changing SUPL triggered service status to ON,it should select ESuplTriggerON.
+* If SUPL triggered service status is set to ESuplTriggerON,then any client requesting triggered service will be served by SUPL Framework.
+* If SUPL triggered service status is set to ESuplTriggerOFF,then client's request for triggered service will fail.
+* If SUPL triggers are in progress and client sets off triggered service,then all started triggering sessions will get completed with error.
+*
+* @since S60 5.2
+*/
+			enum TSuplTriggerStatus
+{
+/** Indicates that SUPL triggered service status is ON */
+ESuplTriggerOn = 0,
+/** Indicates that SUPL triggered service status is OFF */
+ESuplTriggerOff
+};
 public:  // Constructors and destructor
 /**
 * Two-phased constructor.
 *
 * @since S60 3.1
 * @returns A new instance of this class.
 */
 IMPORT_C static CSuplSettings* NewL();
 /**
 * Two-phased constructor.
 *
 * @since S60 5.1
 * @returns A new instance of this class.
 */
 IMPORT_C static CSuplSettings* NewLC();
 /**
 * Destructor.
 *
 * @since S60 3.1
 *
 */
 IMPORT_C ~CSuplSettings();
 protected:
 /**
 * C++ default constructor.
 *
 * @since S60 3.1
 *
 */
 CSuplSettings();
 /**
 * By default EPOC constructor is private.
 *
 * @since S60 3.1
 *
 */
 void ConstructL();
 public: // New functions
 /**
 * This method is used to start listening for SUPL setting changes. To
 * listen for changes, the client must implement the
 * @ref MSuplSettingsObserver interface.  Client must allocated memory
 * for the observer.
 *
 * @since S60 3.1
 *
 */
 IMPORT_C void RemoveObserver();
 /**
 * This method is used to start listening for SUPL session changes. To
 * listen for changes, the client must implement the
 * @ref MSuplSessionObserver interface.  Client must allocated memory
 * for the observer.
 *
 */
 IMPORT_C TInt IsImsiChanged(TBool& aChanged);
 /**
-* This method is used to retrieve SUPL usage from settings storage.
+* This method is deprecated.
 *
-* @since S60 3.2
+* @since S60 10.1
 *
-* @param [OUT] aUsage  will hold, upon successful completion, value indicating
+* @return one of the following error codes:
-* current SUPL usage
+*         - KErrNotSupported
-* @return one of the following error codes:
-*         - KErrNone if SUPL usage retrieved successfully.
-*         - KErrNotFound if the SUPL State is not found in SUPL settings
-*         - KErrUnknown if retrieving SUPL usage from settings storage failed
 */
 IMPORT_C TInt GetSuplUsage(TSuplSettingsUsage& aUsage) const;
 /**
-* This method is used to change SUPL usage.  Using this method, SUPL usage can be
+* This method is deprecated.
-* set to any of the values specified in the enumeration @ref TSuplSettingsUsage
+*
-* By default, SUPL usage will be set to always ask.
+* @since S60 10.1
 *
-* @since S60 3.2
+* @return one of the following error codes:
-*
+*         - KErrNotSupported
-* @param [IN] aUsage Usage to be set for SUPL usage
-* @return one of the following error codes:
-*         - KErrNone if SUPL usage is changed successfully.
-*         - KErrArgument if aUsage field is not in range
-*         - KErrUnknown if changing SUPL usage in settings storage has failed
 */
 IMPORT_C TInt SetSuplUsage(TSuplSettingsUsage aUsage);
 /**
 * This method is used to add new server into settings.  It is client's responsibility
 * to set all the parameters in aParamValues except SLP identification.  After adding
 * server entry, the server identity generated will be retuned with aSlpId.  The returned
 * server identity can be used with other methods change any of server parameters. If server
 IMPORT_C TInt SetEditableFlag(
 const TInt64 aSlpId,
 const TBool aEditFlag
 ) const;
 /**
 * This method is used to retrieve parameter which indicates whether server
 * details are editable or not.
 *
 * @since S60 5.1
 *
 IMPORT_C TInt GetTriggerParams( TInt64 aSessionId,
 CTriggerParams*& aParamValues ) const;
-/*
+/**
 * Sets Notification status of particular session
 *
 * @since S60 5.2
 * @param [IN] aSessionId Session identifier to get/change paramater of particular session
 * @param [IN] aTriggerNotificationStaus  Indicates whether notification needs to be shown or
 */
 	IMPORT_C TInt SetNotificationStatus(
 	            TInt64 aSessionId,
 TBool aTriggerNotificationStatus
 );
-	/*
+	/**
 	 * Cancels given ongoing triggering session
 	 *
 	 * @since S60 5.2
 	 * @param [IN] aSessionId Session identifier
 	 *
 	 *  - KErrArgument if argument passed is of length zero
 	 */
 	IMPORT_C TInt GetDefaultIAPName(TDes& aIapName);
+	/**
+	 * Changes status of SUPL triggered service.
+	 *
+	 * @since S60 10.1
+	 * @param [IN] aSuplTriggerStatus, Indicates the new SUPL triggered service status value
+	 * @capability WriteDeviceData Its required for cenrep write operation.
+	 * @return following error codes
+	 *      - KErrNone if successful
+	 *      otherwise system wide error codes.
+	 */
+	IMPORT_C TInt SetSuplTriggeredServiceStatus( const TSuplTriggerStatus& aSuplTriggerStatus );
+	/**
+	 * Returns the status of SUPL triggered service.
+	 *
+	 * @since S60 10.1
+	 * @param [OUT] aSuplTriggerStatus, Gets status of SUPL triggering session either ON or OFF
+	 * @capability ReadDeviceData Its required for cenrep read operation.
+	 * @return following error codes
+	 *      - KErrNone if successful
+	 *      otherwise system wide error codes.
+	 */
+	IMPORT_C TInt GetSuplTriggeredServiceStatus( TSuplTriggerStatus& aSuplTriggerStatus );
 private: // New functions
 private:
 // By default, prohibit copy constructor
 CSuplSettings( const CSuplSettings& );

branch	RCL_3
changeset 44	2b4ea9893b66
parent 0	667063e416a2
child 45	6b6920c56e2f