inc/FNetNfcINdefPushManagerListener.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    FNetNfcINdefPushManagerListener.h
  19  * @brief   This is the header file for the %INdefPushManagerListener interface.
  20  *
  21  * This header file contains the declarations of the %INdefPushManagerListener interface.
  22  */
  23
  24 #ifndef _FNET_NFC_INDEF_PUSH_MANAGER_LISTENER_H_
  25 #define _FNET_NFC_INDEF_PUSH_MANAGER_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28 #include <FBaseResult.h>
  29
  30 namespace Tizen { namespace Net { namespace Nfc
  31 {
  32 /**
  33  * @interface   INdefPushManagerListener
  34  * @brief       This interface provides a listener for the events related to the %NfcPushManager.
  35  * @since 2.0
  36  *
  37  * The %INdefPushManagerListener interface specifies the methods used for receiving the status of the pushed NDEF message asynchronously.
  38  *
  39  * For more information on the class features, see
  40  * <a href="../com.osp.cppappprogramming.help/html/guide/net/nfc.htm">NFC Guide</a>.
  41  */
  42 class _OSP_EXPORT_ INdefPushManagerListener
  43         : virtual public Tizen::Base::Runtime::IEventListener
  44 {
  45 public:
  46         /**
  47          * This polymorphic destructor should be overridden if required. @n
  48          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  49          *
  50          * @since 2.0
  51          */
  52         virtual ~INdefPushManagerListener(void) {}
  53
  54         /**
  55          * Called when the push operation to the target device is completed.
  56          *
  57          * @since 2.0
  58          *
  59          * @param[in]   r                                       The result of pushed NDEF message @n
  60          *                                                                      Following exceptions may be given through this parameter.
  61          * @exception   E_SUCCESS                       The method is successful.
  62          * @exception   E_NOT_RESPONDING        The device is not responding.
  63          * @exception   E_OPERATION_FAILED      The operation has failed.
  64          */
  65         virtual void OnNdefPushMessageSent(result r) = 0;
  66
  67 protected:
  68         //
  69         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  70         //
  71         // The following methods are reserved, and the name of methods can be changed at any time without prior notice.
  72         //
  73         // @since 2.0
  74         //
  75         virtual void INdefPushManagerListener_Reserved1(void) {}
  76
  77         //
  78         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  79         //
  80         // The following methods are reserved, and the name of methods can be changed at any time without prior notice.
  81         //
  82         // @since 2.0
  83         //
  84         virtual void INdefPushManagerListener_Reserved2(void) {}
  85 }; // INdefPushManagerListener
  86
  87 } } } // Tizen::Net::Nfc
  88
  89 #endif // _FNET_NFC_INDEF_PUSH_MANAGER_LISTENER_H_