2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
18 * @file FAppIAppControlResponseListener.h
19 * @brief This is the header file for the %IAppControlResponseListener interface.
21 * This header file contains the declarations of the %IAppControlResponseListener interface.
24 #ifndef _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
25 #define _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
27 #include <FBaseRtIEventListener.h>
29 namespace Tizen { namespace Base {
31 namespace Collection {
36 namespace Tizen { namespace App
40 * @interface IAppControlResponseListener
41 * @brief This interface defines a listener for the %AppControl response events.
45 * The %IAppControlResponseListener interface defines a listener for the AppControl response events.
47 class _OSP_EXPORT_ IAppControlResponseListener
48 : virtual public Tizen::Base::Runtime::IEventListener
52 * This polymorphic destructor should be overridden if required. @n
53 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
57 virtual ~IAppControlResponseListener(void) {}
60 * Called when the response for an application control completion is received.
64 * @param[in] appId The ID of the requested application
65 * @param[in] operationId The operation ID used in the application control invocation
66 * @param[in] appControlResult The application control result
67 * @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
68 * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
69 * @remarks The application control completion result is received when the requested application control
70 * sends the result using the AppControlProviderManager::SendAppControlResult() method.
73 virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
76 * Called when the application control is about to start or is to be cancelled by the user resolution. @n
77 * The calling application can get the result of the resolution by implementing this empty body method.
81 * @param[in] appId The ID of the requested application
82 * @param[in] operationId The operation ID used in the application control invocation
83 * @param[in] r The result of the application control start response @n
84 * The following exceptions may be given through this parameter.
85 * @exception E_SUCCESS The method is successful.
86 * @exception E_OPERATION_CANCELED The application control resolve request has been cancelled by the user operation.
87 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
88 * @exception E_SYSTEM A system error has occurred.
89 * @remarks This method is invoked only for the implicit AppControl resolution.
90 * @see AppControl::FindAndStart()
92 virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
96 // This method is for internal use only.
97 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
99 // This method is reserved and may change its name at any time without prior notice.
103 virtual void IAppControlResponseListener_Reserved1(void) {}
106 // This method is for internal use only.
107 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
109 // This method is reserved and may change its name at any time without prior notice.
113 virtual void IAppControlResponseListener_Reserved2(void) {}
116 // This method is for internal use only.
117 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
119 // This method is reserved and may change its name at any time without prior notice.
123 virtual void IAppControlResponseListener_Reserved3(void) {}
126 // This method is for internal use only.
127 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
129 // This method is reserved and may change its name at any time without prior notice.
133 virtual void IAppControlResponseListener_Reserved4(void) {}
136 // This method is for internal use only.
137 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
139 // This method is reserved and may change its name at any time without prior notice.
143 virtual void IAppControlResponseListener_Reserved5(void) {}
144 }; // IAppControlResponseListener
148 #endif // _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_