inc/FNetNfcINfcDeviceDiscoveryEventListener.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    FNetNfcINfcDeviceDiscoveryEventListener.h
  19  * @brief   This is the header file for the %INfcDeviceDiscoveryEventListener interface.
  20  *
  21  * This header file contains the declarations of the %INfcDeviceDiscoveryEventListener interface.
  22  */
  23
  24 #ifndef _FNET_NFC_INFC_DEVICE_DISCOVERY_EVENT_LISTENER_H_
  25 #define _FNET_NFC_INFC_DEVICE_DISCOVERY_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   INfcDeviceDiscoveryEventListener
  35  * @brief       This interface provides a listener for the events related to device discovery.
  36  * @since 2.0
  37  *
  38  * The %INfcDeviceDiscoveryEventListener interface specifies the methods used for creating the notifications
  39  * about detecting a device.
  40  *
  41  * For more information on the class features, see
  42  * <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
  43  */
  44 class _OSP_EXPORT_ INfcDeviceDiscoveryEventListener
  45         : virtual public Tizen::Base::Runtime::IEventListener
  46 {
  47 public:
  48         /**
  49          * This polymorphic destructor should be overridden if required. @n
  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         virtual ~INfcDeviceDiscoveryEventListener(void) {}
  55
  56         /**
  57          * Called to notify the application when a device is detected.
  58          *
  59          * @since 2.0
  60          */
  61         virtual void OnNfcDeviceDetected(void) = 0;
  62
  63         /**
  64          * Called to notify the application when a device is lost.
  65          *
  66          * @since 2.0
  67          */
  68         virtual void OnNfcDeviceLost(void) = 0;
  69
  70 protected:
  71         //
  72         // This method is for internal use only. Using this method can cause behavioral, security-related,
  73         // and consistency-related issues in the application.
  74         //
  75         // The following methods are reserved, and the name of methods can be changed at any time without prior notice.
  76         //
  77         // @since 2.0
  78         //
  79         virtual void INfcDeviceDiscoveryEventListener_Reserved1(void) {}
  80
  81         //
  82         // This method is for internal use only. Using this method can cause behavioral, security-related,
  83         // and consistency-related issues in the application.
  84         //
  85         // The following methods are reserved, and the name of methods can be changed at any time without prior notice.
  86         //
  87         // @since 2.0
  88         //
  89         virtual void INfcDeviceDiscoveryEventListener_Reserved2(void) {}
  90 }; // INfcDeviceDiscoveryEventListener
  91
  92 } } } // Tizen::Net::Nfc
  93
  94 #endif // _FNET_NFC_INFC_DEVICE_DISCOVERY_EVENT_LISTENER_H_