X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppIAppControlResponseListener.h;h=57174e27f71c6b53bb4e9bd57b99cf160344158e;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=2b77f434e390b26a2216e895e4e452609b34f78a;hpb=2d6c8829b9a057400384c00d7b080c2090bb873c;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppIAppControlResponseListener.h b/inc/FAppIAppControlResponseListener.h index 2b77f43..57174e2 100644 --- a/inc/FAppIAppControlResponseListener.h +++ b/inc/FAppIAppControlResponseListener.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -16,8 +15,8 @@ // /** - * @file FAppIAppControlResponseListener.h - * @brief This is the header file for the %IAppControlResponseListener interface. + * @file FAppIAppControlResponseListener.h + * @brief This is the header file for the %IAppControlResponseListener interface. * * This header file contains the declarations of the %IAppControlResponseListener interface. */ @@ -39,7 +38,7 @@ namespace Tizen { namespace App /** * @interface IAppControlResponseListener -* @brief This interface defines a listener for the AppControl response events. +* @brief This interface defines a listener for the %AppControl response events. * * @since 2.0 * @@ -50,7 +49,7 @@ class _OSP_EXPORT_ IAppControlResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -58,38 +57,36 @@ public: virtual ~IAppControlResponseListener(void) {} /** - * Called when the response for application control completion is received. + * Called when the response for an application control completion is received. * * @since 2.0 * - * @param[in] appId The ID of the requested application - * @param[in] operationId The operation ID used in application control invocation + * @param[in] appId The ID of the requested application + * @param[in] operationId The operation ID used in the application control invocation * @param[in] appControlResult The application control result - * @param[in] pExtraData A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of - * type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String + * @param[in] pExtraData A pointer to the result 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 * @remarks The application control completion result is received when the requested application control - * sends the result using AppControlProviderManager::SendAppControlResult(). + * sends the result using the AppControlProviderManager::SendAppControlResult() method. * @see AppControl - * @see AppControlProviderManager::SendAppControlResult() */ virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0; /** - * Called when the application control is about to start or to be canceled by the user resolution. @n + * Called when the application control is about to start or is to be cancelled by the user resolution. @n * The calling application can get the result of the resolution by implementing this empty body method. * * @since 2.0 * - * @param[in] appId The ID of the requested application - * @param[in] operationId The operation ID used in application control invocation - * @param[in] r The result of the application control start response @n - * The exception code may be given through this parameter. - * @exception E_SUCCESS The method is successful. - * @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. + * @param[in] appId The ID of the requested application + * @param[in] operationId The operation ID used in the application control invocation + * @param[in] r The result of the application control start response @n + * The following exceptions may be given through this parameter. + * @exception E_SUCCESS The method is successful. + * @exception E_OPERATION_CANCELED The application control resolve request has been cancelled by the user operation. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM A system error has occurred. * @remarks This method is invoked only for the implicit AppControl resolution. - * @see AppControl * @see AppControl::FindAndStart() */ virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}