inc/FNetNfcINfcManagerEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 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  * @file    FNetNfcINfcManagerEventListener.h
  19  * @brief   This is the header file for the %INfcManagerEventListener interface.
  20  *
  21  * This header file contains the declarations of the %INfcManagerEventListener interface.
  22  */
  23
  24 #ifndef _FNET_NFC_INFC_MANAGER_EVENT_LISTENER_H_
  25 #define _FNET_NFC_INFC_MANAGER_EVENT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28 #include <FBaseResult.h>
  29
  30 namespace Tizen { namespace Net { namespace Nfc
  31 {
  32
  33 /**
  34  * @interface   INfcManagerEventListener
  35  * @brief       This interface provides a listener for the events related to the Near field Communication (NFC)
  36  *              manager.
  37  *
  38  * @since       2.0
  39  *
  40  * The %INfcManagerEventListener interface specifies the method used for creating the notifications about a change in
  41  * the NfcManager status.
  42  *
  43  * For more information on the class features, see
  44  * <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
  45  */
  46 class _OSP_EXPORT_ INfcManagerEventListener
  47         : public Tizen::Base::Runtime::IEventListener
  48 {
  49 public:
  50         /**
  51          * This polymorphic destructor should be overridden if required. @n
  52          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  53          *
  54          * @since       2.0
  55          */
  56         virtual ~INfcManagerEventListener(void) {}
  57
  58         /**
  59          * Called to notify when the NFC feature is activated on the device.
  60          *
  61          * @since       2.0
  62          *
  63          * @param[in]   r               The activation status
  64          * @exception   E_SUCCESS       The method is successful.
  65          * @exception   E_SYSTEM        A system error has occurred.
  66          */
  67         virtual void OnNfcActivated(result r) = 0;
  68
  69         /**
  70          * Called to notify when the NFC feature is deactivated on the device.
  71          *
  72          * @since       2.0
  73          *
  74          * @param[in]   r               The deactivation status
  75          * @exception   E_SUCCESS       The method is successful.
  76          * @exception   E_SYSTEM        A system error has occurred.
  77          */
  78         virtual void OnNfcDeactivated(result r) = 0;
  79
  80 protected:
  81         //
  82         // This method is for internal use only. Using this method can cause behavioral, security-related, and
  83         // consistency-related issues in the application.
  84         //
  85         // This method is reserved and may change its name at any time without prior notice.
  86         //
  87         // @since       2.0
  88         //
  89         virtual void INfcManagerEventListener_Reserved1(void) {}
  90
  91         //
  92         // This method is for internal use only. Using this method can cause behavioral, security-related, and
  93         // consistency-related issues in the application.
  94         //
  95         // This method is reserved and may change its name at any time without prior notice.
  96         //
  97         // @since       2.0
  98         //
  99         virtual void INfcManagerEventListener_Reserved2(void) {}
 100
 101         //
 102         // This method is for internal use only. Using this method can cause behavioral, security-related, and
 103         // consistency-related issues in the application.
 104         //
 105         // This method is reserved and may change its name at any time without prior notice.
 106         //
 107         // @since       2.0
 108         //
 109         virtual void INfcManagerEventListener_Reserved3(void) {}
 110
 111         //
 112         // This method is for internal use only. Using this method can cause behavioral, security-related, and
 113         // consistency-related issues in the application.
 114         //
 115         // This method is reserved and may change its name at any time without prior notice.
 116         //
 117         // @since       2.0
 118         //
 119         virtual void INfcManagerEventListener_Reserved4(void) {}
 120
 121         //
 122         // This method is for internal use only. Using this method can cause behavioral, security-related, and
 123         // consistency-related issues in the application.
 124         //
 125         // This method is reserved and may change its name at any time without prior notice.
 126         //
 127         // @since       2.0
 128         //
 129         virtual void INfcManagerEventListener_Reserved5(void) {}
 130
 131 }; // INfcManagerEventListener
 132
 133 } } } // Tizen::Net::Nfc
 134
 135 #endif // _FNET_NFC_INFC_MANAGER_EVENT_LISTENER_H_