src/app/inc/FApp_AppControlImpl.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   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
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  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.
  15 //
  16
  17 /**
  18  * @file        FApp_AppControlImpl.h
  19  * @brief       This is the header file for the _AppControlImpl class.
  20  */
  21
  22 #ifndef _FAPP_INTERNAL_APP_CONTROL_IMPL_H_
  23 #define _FAPP_INTERNAL_APP_CONTROL_IMPL_H_
  24
  25 #include <app_service.h>
  26
  27 #include <FBaseObject.h>
  28 #include <FAppTypes.h>
  29 #include <FOspConfig.h>
  30 #include <FAppAppControl.h>
  31 #include <FBaseColArrayListT.h>
  32
  33 #include "FApp_AppManagerImpl.h"
  34 #include "FApp_IAppControlResponseEventListener.h"
  35
  36 typedef struct _bundle_t bundle;
  37
  38
  39 namespace Tizen { namespace Base { class String; } }
  40 namespace Tizen { namespace Base { namespace Collection { class IList; } } }
  41
  42 namespace Tizen { namespace App
  43 {
  44
  45 class AppControl;
  46 class IAppControlEventListener;
  47 class IAppControlResponseListener;
  48 class _AppArg;
  49
  50 enum _AppControlProperty
  51 {
  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,
  59 };
  60
  61 class _OSP_EXPORT_ _AppControlImpl
  62         : public Tizen::Base::Object
  63         , public Tizen::App::_IAppControlResponseEventListener
  64         , virtual public Tizen::Base::Runtime::IEventListener
  65 {
  66 public:
  67         /**
  68          * AppControl delegate constructor
  69          */
  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);
  71
  72         /**
  73          * AppControl delegate constructor
  74          */
  75         static AppControl* CreateN(const AppId& appId, const Tizen::Base::String& operationId, bool changeAppId);
  76
  77         /**
  78          * AppControl delegate constructor
  79          */
  80         static AppControl* CreateN(const AppControl& ac);
  81
  82         /**
  83          * Internal GetImpl() method.
  84          */
  85         static const _AppControlImpl* GetInstance(const AppControl& ac);
  86
  87         /**
  88          * Internal GetImpl() method.
  89          */
  90         static _AppControlImpl* GetInstance(AppControl& ac);
  91
  92         /**
  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.
  96         *
  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().
 116         */
 117         result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 118
 119         /**
 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.
 123          *
 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()
 142          */
 143         result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
 144
 145         /**
 146          * Gets the name of the application that provides the features represented by this %_AppControlImpl instance.
 147          *
 148          * @return              The name of the application providing this %_AppControlImpl instance
 149          */
 150         Tizen::Base::String GetAppName(void);
 151
 152         /**
 153          * Gets the associated application ID. @n
 154          *
 155          * @return              The application control ID
 156          */
 157         Tizen::Base::String GetAppId(void) const;
 158
 159         /**
 160          * Gets the associated application control provider ID. @n
 161          *
 162          * @return              The application control provider ID
 163          */
 164         const Tizen::Base::String& GetAppControlProviderId(void) const;
 165
 166         /**
 167          * Gets the associated operation ID. @n
 168          *
 169          * @return              The operation ID
 170          */
 171         const Tizen::Base::String& GetOperationId(void) const;
 172
 173         /**
 174          * Returns the associated application control categories.
 175          *
 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.
 182          */
 183         Tizen::Base::Collection::IList* GetCategoryListN(void) const;
 184
 185         /**
 186          * Stops the activated application control. @n
 187          *
 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.
 193          */
 194         result Stop(void);
 195
 196         /**
 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.
 201          *
 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
 216          */
 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);
 218
 219         /**
 220          * Stops the event listener for receiving application control result.
 221          *
 222          * @param[in]  pListener      The listener to stop receiving the application control result
 223          */
 224         static void StopAppControlResponseListener(IAppControlResponseListener* pListener);
 225
 226         static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 227
 228         static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IMap* pData, IAppControlResponseListener* pListener);
 229
 230         bool IsPublic(void) const
 231         {
 232                 return (_property & _APPCONTROL_PROPERTY_PUBLIC);
 233         }
 234
 235         void SetProperty(int prop)
 236         {
 237                 _property |= prop;
 238         }
 239
 240         virtual void OnAppControlResponseEventReceivedN(const Tizen::Base::Runtime::IEventArg* arg);
 241 private:
 242         _AppControlImpl(const AppControl& value);
 243
 244         /**
 245          * This is the default constructor for this class.
 246          */
 247         _AppControlImpl(void);
 248
 249         _AppControlImpl(const _AppControlImpl& rhs);
 250
 251         _AppControlImpl& operator =(const _AppControlImpl& rhs);
 252
 253         /**
 254          * This is the destructor for this class.
 255          */
 256         virtual ~_AppControlImpl(void);
 257
 258         result StartOsp(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 259
 260         result StartOsp(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
 261
 262         result StartNative(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 263
 264         result StartNative(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
 265
 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);
 267
 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);
 269
 270         static result AppControlCbLegacy(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId);
 271
 272         static result AppControlCb(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId);
 273
 274 protected:
 275         const AppControl& _appControl;
 276
 277         Tizen::Base::String _path;
 278         Tizen::Base::String _provider;
 279         Tizen::Base::String _opId;
 280         Tizen::Base::String _appName;
 281         int     _reqId;
 282         int     _property;
 283         int _processId;
 284
 285 private:
 286         Tizen::Base::Collection::ArrayListT<int> __appControlResponseEventList;
 287
 288         friend class AppControl;
 289         friend class _AppArg;
 290 }; // _AppControlImpl
 291
 292 } } // Tizen::App
 293
 294 #endif // _FAPP_INTERNAL_APP_CONTROL_IMPL_H_