inc/FAppPkgIPackageInstallationResponseListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FAppPkgIPackageInstallationResponseListener.h
  20  * @brief       This is the header file for the %IPackageInstallationResponseListener interface.
  21  *
  22  * This header file contains the declarations of the %IPackageInstallationResponseListener interface.
  23  *
  24  */
  25 #ifndef _FAPP_PKG_IPACKAGE_INSTALLATION_RESPONSE_LISTENER_H_
  26 #define _FAPP_PKG_IPACKAGE_INSTALLATION_RESPONSE_LISTENER_H_
  27
  28 #include <FAppPkgPackageManager.h>
  29 #include <FAppPkgIPackageInstallationEventListener.h>
  30 #include <FBaseRtIEventListener.h>
  31
  32 namespace Tizen { namespace App { namespace Package
  33 {
  34
  35 /**
  36  * @interface   IPackageInstallationResponseListener
  37  * @brief               This interface defines a listener for the asynchronous package installation operation.
  38  *
  39  * @since       2.0
  40  *
  41  * The %IPackageInstallationResponseListener interface defines a listener for the asynchronous package installation operation.
  42  *
  43  */
  44 class _OSP_EXPORT_ IPackageInstallationResponseListener
  45         : virtual public Tizen::Base::Runtime::IEventListener
  46 {
  47 public:
  48         /**
  49      * This polymorphic destructor should be overridden if required.
  50      * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  51      *
  52      * @since   2.0
  53      *
  54      */
  55         virtual ~IPackageInstallationResponseListener(void) {}
  56
  57         /**
  58      * Called when a package installation is completed. @n
  59          * The value of @c installationResult is @c PACKAGE_INSTALLATION_RESULT_SUCCESS if the installation is successful.
  60      *
  61      * @since   2.0
  62      *
  63      * @param[in]       packageId                       The package ID
  64      * @param[in]       installationResult              The installation result
  65      *
  66      */
  67         virtual void OnPackageInstallationResponseReceived(const PackageId& packageId, PackageInstallationResult installationResult) = 0;
  68
  69         /**
  70      * Called when a package installation is in progress.
  71      *
  72      * @since   2.0
  73      *
  74      * @param[in]       packageId                       The package ID
  75      * @param[in]       progress                The progress of an installation in percentage
  76      *
  77      */
  78         virtual void OnPackageInstallationInProgressResponseReceived(const PackageId& packageId, int progress) = 0;
  79
  80
  81 protected:
  82         //
  83         // This method is for internal use only.
  84         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  85         //
  86         // This method is reserved and may change its name at any time without prior notice.
  87         //
  88         // @since       2.0
  89         //
  90         virtual void IPackageInstallationResponseListener_Reserved1(void) {}
  91
  92         //
  93         // This method is for internal use only.
  94         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  95         //
  96         // This method is reserved and may change its name at any time without prior notice.
  97         //
  98         // @since       2.0
  99         //
 100         virtual void IPackageInstallationResponseListener_Reserved2(void) {}
 101
 102         //
 103         // This method is for internal use only.
 104         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 105         //
 106         // This method is reserved and may change its name at any time without prior notice.
 107         //
 108         // @since       2.0
 109         //
 110         virtual void IPackageInstallationResponseListener_Reserved3(void) {}
 111
 112 }; // IPackageInstallationResponseListener
 113
 114 } } } // Tizen::App::Package
 115
 116 #endif // _FAPP_PKG_IPACKAGE_INSTALLATION_RESPONSE_LISTENER_H_