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.
  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 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 application control invocation
  66          * @param[in]   appControlResult        The application control result
  67          * @param[in]   pExtraData              A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of
  68          *                                                      type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String
  69          * @remarks     The application control completion result is received when the requested application control
  70          *                      sends the result using AppControlProviderManager::SendAppControlResult().
  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 to be canceled 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 application control invocation
  83          * @param[in]   r                               The result of the application control start response @n
  84          *                                                              The exception code may be given through this parameter.
  85          * @exception   E_SUCCESS               The method is successful.
  86          * @exception   E_OPERATION_CANCELED    The application control resolve request is canceled by a 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
  91          * @see AppControl::FindAndStart()
  92          */
  93         virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
  94
  95 protected:
  96         //
  97         // This method is for internal use only.
  98         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  99         //
 100         // This method is reserved and may change its name at any time without prior notice.
 101         //
 102         // @since       2.0
 103         //
 104         virtual void IAppControlResponseListener_Reserved1(void) {}
 105
 106         //
 107         // This method is for internal use only.
 108         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 109         //
 110         // This method is reserved and may change its name at any time without prior notice.
 111         //
 112         // @since       2.0
 113         //
 114         virtual void IAppControlResponseListener_Reserved2(void) {}
 115
 116         //
 117         // This method is for internal use only.
 118         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 119         //
 120         // This method is reserved and may change its name at any time without prior notice.
 121         //
 122         // @since       2.0
 123         //
 124         virtual void IAppControlResponseListener_Reserved3(void) {}
 125
 126         //
 127         // This method is for internal use only.
 128         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 129         //
 130         // This method is reserved and may change its name at any time without prior notice.
 131         //
 132         // @since       2.0
 133         //
 134         virtual void IAppControlResponseListener_Reserved4(void) {}
 135
 136         //
 137         // This method is for internal use only.
 138         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 139         //
 140         // This method is reserved and may change its name at any time without prior notice.
 141         //
 142         // @since       2.0
 143         //
 144         virtual void IAppControlResponseListener_Reserved5(void) {}
 145 }; // IAppControlResponseListener
 146
 147 } } // Tizen::App
 148
 149 #endif // _FAPP_IAPP_CONTROL_RESPONSE_LISTENER_H_