inc/FAppIAppControlResponseListener.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        FAppIAppControlResponseListener.h
  19  * @brief       This is the header file for the %IAppControlResponseListener interface.
  20  *
  21  * This header file contains the declarations of the %IAppControlResponseListener interface.
  22  */
  23
  24 #ifndef _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
  25 #define _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Base {
  30 class String;
  31 namespace Collection {
  32 class IMap;
  33 }
  34 }}
  35
  36 namespace Tizen { namespace App
  37 {
  38
  39 /**
  40 * @interface    IAppControlResponseListener
  41 * @brief                This interface defines a listener for the %AppControl response events.
  42 *
  43 * @since        2.0
  44 *
  45 * The %IAppControlResponseListener interface defines a listener for the AppControl response events.
  46 */
  47 class _OSP_EXPORT_ IAppControlResponseListener
  48         : virtual public Tizen::Base::Runtime::IEventListener
  49 {
  50 public:
  51         /**
  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.
  54          *
  55          * @since       2.0
  56          */
  57         virtual ~IAppControlResponseListener(void) {}
  58
  59         /**
  60          * Called when the response for an application control completion is received.
  61          *
  62          * @since       2.0
  63          *
  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.
  71          * @see         AppControl
  72          */
  73         virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
  74
  75         /**
  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.
  78          *
  79          * @since       2.0
  80          *
  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()
  91          */
  92         virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
  93
  94 protected:
  95         //
  96         // This method is for internal use only.
  97         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  98         //
  99         // This method is reserved and may change its name at any time without prior notice.
 100         //
 101         // @since       2.0
 102         //
 103         virtual void IAppControlResponseListener_Reserved1(void) {}
 104
 105         //
 106         // This method is for internal use only.
 107         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 108         //
 109         // This method is reserved and may change its name at any time without prior notice.
 110         //
 111         // @since       2.0
 112         //
 113         virtual void IAppControlResponseListener_Reserved2(void) {}
 114
 115         //
 116         // This method is for internal use only.
 117         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 118         //
 119         // This method is reserved and may change its name at any time without prior notice.
 120         //
 121         // @since       2.0
 122         //
 123         virtual void IAppControlResponseListener_Reserved3(void) {}
 124
 125         //
 126         // This method is for internal use only.
 127         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 128         //
 129         // This method is reserved and may change its name at any time without prior notice.
 130         //
 131         // @since       2.0
 132         //
 133         virtual void IAppControlResponseListener_Reserved4(void) {}
 134
 135         //
 136         // This method is for internal use only.
 137         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 138         //
 139         // This method is reserved and may change its name at any time without prior notice.
 140         //
 141         // @since       2.0
 142         //
 143         virtual void IAppControlResponseListener_Reserved5(void) {}
 144 }; // IAppControlResponseListener
 145
 146 } } // Tizen::App
 147
 148 #endif // _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_