inc/FNetNfcINfcTagDiscoveryEventListener.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    FNetNfcINfcTagDiscoveryEventListener.h
  19  * @brief   This is the header file for the %INfcTagDiscoveryEventListener interface.
  20  *
  21  * This header file contains the declarations of the %INfcTagDiscoveryEventListener interface.
  22  */
  23
  24 #ifndef _FNET_NFC_INFC_TAG_DISCOVERY_EVENT_LISTENER_H_
  25 #define _FNET_NFC_INFC_TAG_DISCOVERY_EVENT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Net { namespace Nfc
  30 {
  31
  32 class TagConnection;
  33
  34 /**
  35  * @interface   INfcTagDiscoveryEventListener
  36  * @brief       This interface provides a listener for the events related to tag discovery.
  37  *
  38  * @since       2.0
  39  *
  40  * The %INfcTagDiscoveryEventListener interface specifies the methods used for creating the notifications about
  41  * detecting the target tag.
  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_ INfcTagDiscoveryEventListener
  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 ~INfcTagDiscoveryEventListener(void) {}
  57
  58         /**
  59          * Called to notify the application when the tag is detected by the device.
  60          *
  61          * @since       2.0
  62          *
  63          * @param[in]   pConnection         The connection established with the detected tag
  64          * @remarks     TagConnection is inherited by NdefTagConnection if the current attached tag supports NDEF
  65          *              operations.
  66          *              To verify this, use TagConnection::IsNdefConnection().
  67          */
  68         virtual void OnNfcTagDetectedN(TagConnection* pConnection) = 0;
  69
  70         /**
  71          * Called to notify the application when the tag is lost by the device.
  72          *
  73          * @since       2.0
  74          *
  75          * @remarks     The operations of TagConnection returned by OnNfcTagDetectedN() are not processed further after
  76          *              this event is called, that is, the target tag is lost. Moreover, the TagConnection object cannot be
  77          *              reused even though the same tag is detected again by the device.
  78          */
  79         virtual void OnNfcTagLost(void) = 0;
  80
  81 protected:
  82         //
  83         // This method is for internal use only. Using this method can cause behavioral, security-related, and
  84         // 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 INfcTagDiscoveryEventListener_Reserved1(void) {}
  91
  92         //
  93         // This method is for internal use only. Using this method can cause behavioral, security-related, and
  94         // 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 INfcTagDiscoveryEventListener_Reserved2(void) {}
 101
 102         //
 103         // This method is for internal use only. Using this method can cause behavioral, security-related, and
 104         // 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 INfcTagDiscoveryEventListener_Reserved3(void) {}
 111 }; // INfcTagDiscoveryEventListener
 112
 113 } } } // Tizen::Net::Nfc
 114
 115 #endif // _FNET_NFC_INFC_TAG_DISCOVERY_EVENT_LISTENER_H_