//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class AppControlProviderManager
- * @brief This class manages the AppControl provider.
+ * @brief This class manages the %AppControl provider.
*
* @since 2.0
*
* The %AppControl provider registers or unregisters the IAppControlProviderEventListener listener
* for providing the %AppControl functionality, looks up for the delivered %AppControl request information,
* and sends the %AppControl result back to the calling application. @n
- *
- * The request ID is used to identify each %AppControl request and can be acquired using
- * IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * The request ID is used to identify each %AppControl request and can be acquired using the
+ * IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
*/
class _OSP_EXPORT_ AppControlProviderManager
{
public:
/**
- * Gets the application control provider manager instance.
+ * Gets a pointer to the %AppControlProviderManager instance.
*
* @since 2.0
*
- * @return A pointer to the %AppControlProviderManager instance if it succeeds, @n
- * else @c null
+ * @return A pointer to the %AppControlProviderManager instance, @n
+ * else @c null if it fails
*/
static AppControlProviderManager* GetInstance(void);
* Sets the application control provider listener to the application control provider manager. @n
* The listener gets notified when the application control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter. @n
- *
- * If the application does not set the listener using %SetAppControlProviderEventListener(),
+ * If the application does not set the listener using the %SetAppControlProviderEventListener() method,
* then the application is launched or moves to the foreground without invoking any listener
* for the application request from another application.
*
* @since 2.0
*
- * @return An error code
- * @param[in] pListener The application control provider listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for the valid %App class.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If the application is newly launched with the AppControl request, then %SetAppControlProviderEventListener() must
- * be set before invoking IAppControlProviderEventListener::OnAppControlRequestReceived().
- * For valid %AppControl request handling, %SetAppControlProviderEventListener() must be called within
- * App::OnAppInitializing().
+ * @return An error code
+ * @param[in] pListener The application control provider listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_OPERATION The listener must be set for the valid App class.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - If the application is newly launched with the AppControl request, then the %SetAppControlProviderEventListener() method must
+ * be set before invoking the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
+ * - For valid %AppControl request handling, the %SetAppControlProviderEventListener() method within App::OnAppInitializing()
+ * must be called.
*/
result SetAppControlProviderEventListener(IAppControlProviderEventListener* pListener);
*
* @since 2.0
*
- * @return The application ID @n
- * If an error occurs, an empty string is returned.
- * @param[in] reqId The requestID
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
+ * @return The application ID, @n
+ * else an empty string is returned if an error occurs
+ * @param[in] reqId The requestID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
AppId GetClientAppId(RequestId reqId) const;
/**
* Sends the result list for the application control request. @n
- * The client receives the result by implementing IAppControlResponseListener::OnAppControlCompleteResponseReceived().
+ * The client receives the result by implementing the IAppControlResponseListener::OnAppControlCompleteResponseReceived() method.
*
* @since 2.0
*
- * @return An error code
- * @param[in] reqId The application control request ID
+ * @return An error code
+ * @param[in] reqId The application control request ID
* @param[in] appControlResult The application control result
- * @param[in] pExtraData A pointer to an extra argument map of key and value pair where the key is of type String and the value is of type String or type ArrayList of String
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] pExtraData A pointer to the extra argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SendAppControlResult(RequestId reqId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData);