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 FApp_AppControlImpl.h
19 * @brief This is the header file for the _AppControlImpl class.
22 #ifndef _FAPP_INTERNAL_APP_CONTROL_IMPL_H_
23 #define _FAPP_INTERNAL_APP_CONTROL_IMPL_H_
25 #include <app_service.h>
27 #include <FBaseObject.h>
28 #include <FAppTypes.h>
29 #include <FOspConfig.h>
30 #include <FAppAppControl.h>
31 #include <FBaseColArrayListT.h>
33 #include "FApp_AppManagerImpl.h"
34 #include "FApp_IAppControlResponseEventListener.h"
36 typedef struct _bundle_t bundle;
39 namespace Tizen { namespace Base { class String; } }
40 namespace Tizen { namespace Base { namespace Collection { class IList; } } }
42 namespace Tizen { namespace App
46 class IAppControlEventListener;
47 class IAppControlResponseListener;
50 enum _AppControlProperty
52 _APPCONTROL_PROPERTY_NONE = 0x0,
53 _APPCONTROL_PROPERTY_PUBLIC = 0x01,
54 _APPCONTROL_PROPERTY_PERSISTENT_DLL = 0x08,
55 _APPCONTROL_PROPERTY_SLP = 0x100,
56 _APPCONTROL_PROPERTY_OSP = 0x200,
57 _APPCONTROL_PROPERTY_ALIAS = 0x400,
58 _APPCONTROL_PROPERTY_APPID_CHANGE = 0x800,
61 class _OSP_EXPORT_ _AppControlImpl
62 : public Tizen::Base::Object
63 , public Tizen::App::_IAppControlResponseEventListener
64 , virtual public Tizen::Base::Runtime::IEventListener
68 * AppControl delegate constructor
70 static AppControl* CreateN(const Tizen::Base::String& path, const Tizen::Base::String& aId, const Tizen::Base::String& oId, const Tizen::Base::String& name, int prop);
73 * AppControl delegate constructor
75 static AppControl* CreateN(const AppId& appId, const Tizen::Base::String& operationId, bool changeAppId);
78 * AppControl delegate constructor
80 static AppControl* CreateN(const AppControl& ac);
83 * Internal GetImpl() method.
85 static const _AppControlImpl* GetInstance(const AppControl& ac);
88 * Internal GetImpl() method.
90 static _AppControlImpl* GetInstance(AppControl& ac);
93 * Starts the resolved application control. @n
94 * Once the application starts, it goes to the background and the target
95 * application control is displayed.
97 * @return An error code
98 * @param[in] pDataList The data list to deliver to the resolved application control @n
99 * The maximum size of the list is 4096 bytes.
100 * @param[in] pListener The application control callback listener @n
101 * Some application controls need to get the callback result by implementing
102 * the IAppControlEventListener interface.
103 * @exception E_SUCCESS The method is successful.
104 * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
105 * @exception E_OUT_OF_MEMORY The memory is insufficient.
106 * @exception E_OBJ_NOT_FOUND The target application control resource is not found.
107 * @exception E_IN_PROGRESS The application control is in progress: @n
108 * - The application has already started an _AppControlImpl. @n
109 * - The target application has already started.
110 * @exception E_SYSTEM A system error has occurred.
111 * @remarks If the %IAppControlEventListener instance (@c pListener) needs to get the
112 * callback result for an application control, it should be valid till
113 * IAppControlEventListener::OnAppControlCompleted() is invoked.
114 * For example, a form object listener should not be deleted before the
115 * system invokes IAppControlEventListener::OnAppControlCompleted().
117 result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
120 * Starts the found application control. @n
121 * Once the found application starts, the calling application goes to the background and the found
122 * application is displayed.
124 * @return An error code
125 * @param[in] pUriData A pointer to the URI data
126 * @param[in] pDataType A pointer to the MIME type (RFC 2046) data
127 * @param[in] pExtraData The Tizen::Base::String key and Tizen::Base::String value pair map to deliver to the resolved application @n
128 * The maximum size is 16 kilo bytes.
129 * @param[in] pListener The application control callback listener @n
130 * Some application need to get the result by implementing the IAppControlResponseListener interface.
131 * @exception E_SUCCESS The method is successful.
132 * @exception E_MAX_EXCEEDED The size of @c pExtraData has exceeded the maximum limit.
133 * @exception E_OBJ_NOT_FOUND The target application control is not found.
134 * @exception E_IN_PROGRESS The application control is in progress: @n
135 * - The application has already started an %AppControl.
136 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
137 * @remarks If the calling application needs to get some result for application control,
138 * it must be valid till %IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked.
139 * For example, a form object listener must not be deleted before the
140 * system invokes %IAppControlResponseListener::OnAppControlCompleteResponseReceived().
141 * @see IAppControlResponseListener, AppManager::FindAppControlN(), AppManager::FindAppControlsN()
143 result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
146 * Gets the name of the application that provides the features represented by this %_AppControlImpl instance.
148 * @return The name of the application providing this %_AppControlImpl instance
150 Tizen::Base::String GetAppName(void);
153 * Gets the associated application ID. @n
155 * @return The application control ID
157 Tizen::Base::String GetAppId(void) const;
160 * Gets the associated application control provider ID. @n
162 * @return The application control provider ID
164 const Tizen::Base::String& GetAppControlProviderId(void) const;
167 * Gets the associated operation ID. @n
169 * @return The operation ID
171 const Tizen::Base::String& GetOperationId(void) const;
174 * Returns the associated application control categories.
176 * @return A pointer to the list of application control categories, @n
177 * else @c null if an error occurs
178 * @exception E_SUCCESS The method is successful.
179 * @exception E_OUT_OF_MEMORY The memory is insufficient.
180 * @exception E_SYSTEM A system error has occurred.
181 * @remarks The specific error code can be accessed using the GetLastResult() method.
183 Tizen::Base::Collection::IList* GetCategoryListN(void) const;
186 * Stops the activated application control. @n
188 * @return An error code
189 * @exception E_SUCCESS The method is successful.
190 * @exception E_SYSTEM A system error has occurred.
191 * @exception E_INVALID_OPERATION The application control is not permitted to call this method.
192 * @remarks This method is asynchronous.
197 * Finds the matching application control with given operation ID, URI pattern, data type and category and
198 * starts the found one. @n
199 * If there are more than one application controls found, then the selection is shown for user and the one that the user selects is started.
200 * When the found application control is started, the URI pattern, MIME type, and extra data is delivered via IAppControlProviderEventListener.
202 * @return An error code
203 * @param[in] pOperationId The operation ID
204 * @param[in] pUriPattern A URI pattern which is used for application control resolution and to be delivered as the argument
205 * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
206 * The '.' prefix must be used when specifying the file extension.
207 * @param[in] pCategory The application control category
208 * @param[in] pExtraData The extra collection data to be delivered to the resolved application @n
209 * The maximum size is 16 kilo bytes.
210 * @param[in] pListener A listener that gets notified
211 * @exception E_SUCCESS The method is successful.
212 * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
213 * @exception E_OBJ_NOT_FOUND The application control is not found.
214 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
215 * @see IAppControlResponseListener, IAppControlProviderEventListener
217 static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
220 * Stops the event listener for receiving application control result.
222 * @param[in] pListener The listener to stop receiving the application control result
224 static void StopAppControlResponseListener(IAppControlResponseListener* pListener);
226 static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
228 static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IMap* pData, IAppControlResponseListener* pListener);
230 bool IsPublic(void) const
232 return (_property & _APPCONTROL_PROPERTY_PUBLIC);
235 void SetProperty(int prop)
240 virtual void OnAppControlResponseEventReceivedN(const Tizen::Base::Runtime::IEventArg* arg);
242 _AppControlImpl(const AppControl& value);
245 * This is the default constructor for this class.
247 _AppControlImpl(void);
249 _AppControlImpl(const _AppControlImpl& rhs);
251 _AppControlImpl& operator =(const _AppControlImpl& rhs);
254 * This is the destructor for this class.
256 virtual ~_AppControlImpl(void);
258 result StartOsp(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
260 result StartOsp(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
262 result StartNative(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
264 result StartNative(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
266 static result InvokeStartAppControl(Tizen::Base::Runtime::_LibraryImpl& lib, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap);
268 static result InvokeStartAppControl(Tizen::Base::Runtime::_LibraryImpl& lib, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IList* pList);
270 static result AppControlCbLegacy(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId);
272 static result AppControlCb(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId);
275 const AppControl& _appControl;
277 Tizen::Base::String _path;
278 Tizen::Base::String _provider;
279 Tizen::Base::String _opId;
280 Tizen::Base::String _appName;
286 Tizen::Base::Collection::ArrayListT<int> __appControlResponseEventList;
288 friend class AppControl;
289 friend class _AppArg;
290 }; // _AppControlImpl
294 #endif // _FAPP_INTERNAL_APP_CONTROL_IMPL_H_