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 <FBaseObject.h>
  26 #include <FAppTypes.h>
  27 #include <FOspConfig.h>
  28 #include <FAppAppControl.h>
  29 #include <FBaseColArrayListT.h>
  30
  31 #include <FBaseRt_LibraryImpl.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 namespace Tizen { namespace Base { namespace Runtime { class IEventListener; } } }
  42
  43 namespace Tizen { namespace App
  44 {
  45
  46 class AppControl;
  47 class IAppControlEventListener;
  48 class IAppControlResponseListener;
  49 class _IAppControlPluginProvider;
  50 class _AppMessageImpl;
  51
  52 enum _AppControlProperty
  53 {
  54         _APPCONTROL_PROPERTY_NONE = 0x0,
  55         _APPCONTROL_PROPERTY_PUBLIC = 0x01,
  56         _APPCONTROL_PROPERTY_SUBMODE = 0x1000,
  57         _APPCONTROL_PROPERTY_SERVICE_CALLEE = 0x2000,
  58 };
  59
  60 class _OSP_LOCAL_ _AppControlImpl
  61         : public Tizen::Base::Object
  62         , public Tizen::App::_IAppControlResponseEventListener
  63         , virtual public Tizen::Base::Runtime::IEventListener
  64 {
  65 public:
  66         /**
  67          * AppControl delegate constructor
  68          */
  69         static AppControl* CreateN(const Tizen::Base::String& path, const Tizen::Base::String& aId, const Tizen::Base::String& oId, int prop);
  70
  71         /**
  72          * Internal GetImpl() method.
  73          */
  74         static const _AppControlImpl* GetInstance(const AppControl& ac)
  75         {
  76                 return ac.__pAppControlImpl;
  77         }
  78
  79         /**
  80          * Internal GetImpl() method.
  81          */
  82         static _AppControlImpl* GetInstance(AppControl& ac)
  83         {
  84                 return ac.__pAppControlImpl;
  85         }
  86
  87         /**
  88          * Starts the resolved application control. @n
  89          * Once the application starts, it goes to the background and the target
  90          * application control is displayed.
  91          *
  92          * @return              An error code
  93          * @param[in]   pDataList       The data list to deliver to the resolved application control @n
  94          *                                                      The maximum size of the list is 4096 bytes.
  95          * @param[in]   pListener       The application control callback listener @n
  96          *                                                      Some application controls need to get the callback result by implementing
  97          *                                                      the IAppControlEventListener interface.
  98          * @exception   E_SUCCESS                               The method is successful.
  99          * @exception   E_MAX_EXCEEDED                  The size of @c pDataList has exceeded the maximum limit.
 100          * @exception   E_OUT_OF_MEMORY                 The memory is insufficient.
 101          * @exception   E_OBJ_NOT_FOUND                 The target application control resource is not found.
 102          * @exception   E_IN_PROGRESS                   The application control is in progress: @n
 103          *                                       - The application has already started an _AppControlImpl. @n
 104          *                                       - The target application has already started.
 105          * @exception   E_SYSTEM                                A system error has occurred.
 106          * @remarks             If the %IAppControlEventListener instance (@c pListener) needs to get the
 107          *               callback result for an application control, it should be valid till
 108          *               IAppControlEventListener::OnAppControlCompleted() is invoked.
 109          *               For example, a form object listener should not be deleted before the
 110          *               system invokes IAppControlEventListener::OnAppControlCompleted().
 111          */
 112         result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 113
 114         /**
 115          * Starts the found application control. @n
 116          * Once the found application starts, the calling application goes to the background and the found
 117          * application is displayed.
 118          *
 119          * @return      An error code
 120          * @param[in]   pUriData    A pointer to the URI data
 121          * @param[in]   pDataType   A pointer to the MIME type (RFC 2046) data
 122          * @param[in]   pExtraData  The Tizen::Base::String key and Tizen::Base::String value pair map to deliver to the resolved application @n
 123          *                          The maximum size is 16 kilo bytes.
 124          * @param[in]   pListener   The application control callback listener @n
 125          *                          Some application need to get the result by implementing the IAppControlResponseListener interface.
 126          * @exception   E_SUCCESS               The method is successful.
 127          * @exception   E_MAX_EXCEEDED          The size of @c pExtraData has exceeded the maximum limit.
 128          * @exception   E_OBJ_NOT_FOUND         The target application control is not found.
 129          * @exception   E_IN_PROGRESS           The application control is in progress: @n
 130          *                                       - The application has already started an %AppControl.
 131          * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
 132          * @remarks     If the calling application needs to get some result for application control,
 133          *              it must be valid till %IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked.
 134          *              For example, a form object listener must not be deleted before the
 135          *              system invokes %IAppControlResponseListener::OnAppControlCompleteResponseReceived().
 136          * @see IAppControlResponseListener, AppManager::FindAppControlN(), AppManager::FindAppControlsN()
 137          */
 138         result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
 139
 140         /**
 141          * Gets the name of the application that provides the features represented by this %_AppControlImpl instance.
 142          *
 143          * @return              The name of the application providing this %_AppControlImpl instance
 144          */
 145         Tizen::Base::String GetAppName(void) const;
 146
 147         /**
 148          * Gets the associated application ID. @n
 149          *
 150          * @return              The application control ID
 151          */
 152         Tizen::Base::String GetAppId(void) const
 153         {
 154                 return _appId;
 155         }
 156
 157         /**
 158          * Gets the associated application control provider ID. @n
 159          *
 160          * @return              The application control provider ID
 161          */
 162         Tizen::Base::String GetAppControlProviderId(void) const
 163         {
 164                 return _appId;
 165         }
 166
 167         /**
 168          * Gets the associated operation ID. @n
 169          *
 170          * @return              The operation ID
 171          */
 172         Tizen::Base::String GetOperationId(void) const
 173         {
 174                 return _opId;
 175         }
 176
 177         /**
 178          * Returns the associated application control categories.
 179          *
 180          * @return      A pointer to the list of application control categories, @n
 181               *               else @c null if an error occurs
 182          * @exception   E_SUCCESS       The method is successful.
 183          * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
 184          * @exception   E_SYSTEM                        A system error has occurred.
 185          * @remarks     The specific error code can be accessed using the GetLastResult() method.
 186          */
 187         Tizen::Base::Collection::IList* GetCategoryListN(void) const;
 188
 189         /**
 190          * Stops the activated application control. @n
 191          *
 192          * @return          An error code
 193          * @exception E_SUCCESS                        The method is successful.
 194          * @exception E_SYSTEM                         A system error has occurred.
 195          * @exception E_INVALID_OPERATION        The application control is not permitted to call this method.
 196          * @remarks     This method is asynchronous.
 197          */
 198         result Stop(void);
 199
 200         /**
 201          * Finds the matching application control with given operation ID, URI pattern, data type and category and
 202          * starts the found one. @n
 203          * 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.
 204          * When the found application control is started, the URI pattern, MIME type, and extra data is delivered via IAppControlProviderEventListener.
 205          *
 206          * @return  An error code
 207          * @param[in]   pOperationId   The operation ID
 208          * @param[in]   pUriPattern           A URI pattern which is used for application control resolution and to be delivered as the argument
 209          * @param[in]   pDataType   The MIME type (RFC 2046) or file extension @n
 210          *                          The '.' prefix must be used when specifying the file extension.
 211          * @param[in]   pCategory      The application control category
 212          * @param[in]   pExtraData     The extra collection data to be delivered to the resolved application @n
 213          *                                                   The maximum size is 16 kilo bytes.
 214          * @param[in]   pListener   A listener that gets notified
 215          * @exception   E_SUCCESS           The method is successful.
 216          * @exception   E_MAX_EXCEEDED      The size of @c pDataList has exceeded the maximum limit.
 217          * @exception   E_OBJ_NOT_FOUND     The application control is not found.
 218          * @exception  E_SYSTEM                              The method cannot proceed due to a severe system error.
 219          * @see IAppControlResponseListener, IAppControlProviderEventListener
 220          */
 221         _OSP_EXPORT_ 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);
 222
 223         /**
 224          * Stops the event listener for receiving application control result.
 225          *
 226          * @param[in]  pListener      The listener to stop receiving the application control result
 227          */
 228         static void StopAppControlResponseListener(IAppControlResponseListener* pListener);
 229
 230         static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
 231
 232         static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IMap* pData, IAppControlResponseListener* pListener);
 233
 234         static result StartImplicit(const _AppMessageImpl& msg, Tizen::Base::Runtime::IEventListener* pListener, bool isLegacy);
 235
 236         bool IsPublic(void) const
 237         {
 238                 return (_property & _APPCONTROL_PROPERTY_PUBLIC);
 239         }
 240
 241         void SetProperty(int prop)
 242         {
 243                 _property |= prop;
 244         }
 245
 246         virtual void OnAppControlResponseEventReceivedN(const Tizen::Base::Runtime::IEventArg* arg);
 247 private:
 248         explicit _AppControlImpl(const AppControl& value);
 249
 250         /**
 251          * This is the default constructor for this class.
 252          */
 253         _AppControlImpl(void);
 254
 255         _AppControlImpl(const _AppControlImpl& rhs);
 256
 257         _AppControlImpl& operator =(const _AppControlImpl& rhs);
 258
 259         /**
 260          * This is the destructor for this class.
 261          */
 262         virtual ~_AppControlImpl(void);
 263
 264         static _IAppControlPluginProvider* GetAppControlPluginProvider(const Tizen::Base::String& path);
 265
 266         static result InvokeStartAppControl(_IAppControlPluginProvider* pProvider, 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(_IAppControlPluginProvider* pProvider, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IList* pList);
 269
 270         static result InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const Tizen::Base::String& appId, const _AppMessageImpl& message);
 271
 272 protected:
 273         static const unsigned long _LIBRARY_OPTION = Tizen::Base::Runtime::_LIBRARY_LOAD_OPTION_LAZY | Tizen::Base::Runtime::_LIBRARY_LOAD_OPTION_NODELETE;
 274
 275         const AppControl& _appControl;
 276
 277         Tizen::Base::String _path;
 278         Tizen::Base::String _appId;
 279         Tizen::Base::String _opId;
 280         mutable 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 }; // _AppControlImpl
 290
 291 } } // Tizen::App
 292
 293 #endif // _FAPP_INTERNAL_APP_CONTROL_IMPL_H_