2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FAppIAppControlResponseListener.h
20 * @brief This is the header file for the %IAppControlResponseListener interface.
22 * This header file contains the declarations of the %IAppControlResponseListener interface.
25 #ifndef _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
26 #define _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
28 #include <FBaseRtIEventListener.h>
30 namespace Tizen { namespace Base {
32 namespace Collection {
37 namespace Tizen { namespace App
41 * @interface IAppControlResponseListener
42 * @brief This interface defines a listener for the AppControl response events.
46 * The %IAppControlResponseListener interface defines a listener for the AppControl response events.
48 class _OSP_EXPORT_ IAppControlResponseListener
49 : virtual public Tizen::Base::Runtime::IEventListener
53 * This polymorphic destructor should be overridden if required.
54 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
58 virtual ~IAppControlResponseListener(void) {}
61 * Called when the response for application control completion is received.
65 * @param[in] appId The ID of the requested application
66 * @param[in] operationId The operation ID used in application control invocation
67 * @param[in] appControlResult The application control result
68 * @param[in] pExtraData A pointer to an result map of key and value pair where the key of type String and the value of type String or of type ArrayList of String
69 * @remarks The application control completion result is received when the requested application control
70 * sends the result using AppControlProviderManager::SendAppControlResult().
72 * @see AppControlProviderManager::SendAppControlResult()
74 virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
77 * Called when the application control is about to start or to be canceled by the user resolution. @n
78 * The calling application can get the result of the resolution by implementing this empty body method.
82 * @param[in] appId The ID of the requested application
83 * @param[in] operationId The operation ID used in application control invocation
84 * @param[in] r The result of the application control start response @n
85 * The exception code may be given through this parameter.
86 * @exception E_SUCCESS The method is successful.
87 * @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation.
88 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
89 * @exception E_SYSTEM A system error has occurred.
90 * @remarks This method is invoked only for the implicit AppControl resolution.
92 * @see AppControl::FindAndStart()
94 virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
98 // This method is for internal use only.
99 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
101 // This method is reserved and may change its name at any time without prior notice.
105 virtual void IAppControlResponseListener_Reserved1(void) {}
108 // This method is for internal use only.
109 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
111 // This method is reserved and may change its name at any time without prior notice.
115 virtual void IAppControlResponseListener_Reserved2(void) {}
118 // This method is for internal use only.
119 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
121 // This method is reserved and may change its name at any time without prior notice.
125 virtual void IAppControlResponseListener_Reserved3(void) {}
128 // This method is for internal use only.
129 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
131 // This method is reserved and may change its name at any time without prior notice.
135 virtual void IAppControlResponseListener_Reserved4(void) {}
138 // This method is for internal use only.
139 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
141 // This method is reserved and may change its name at any time without prior notice.
145 virtual void IAppControlResponseListener_Reserved5(void) {}
146 }; // IAppControlResponseListener
150 #endif // _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_