inc/FMsgIWapPushEventListener.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                 FMsgIWapPushEventListener.h
  19 * @brief                This is the header file for the %IWapPushEventListener interface.
  20 *
  21 * This header file contains the declaration of the %IWapPushEventListener interface.
  22 */
  23
  24 #ifndef _FMSG_IWAP_PUSH_EVENT_LISTENER_H_
  25 #define _FMSG_IWAP_PUSH_EVENT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28 #include <FMsgWapPushMessage.h>
  29
  30 namespace Tizen { namespace Messaging
  31 {
  32 /**
  33 * @interface    IWapPushEventListener
  34 * @brief                This is the listener interface for receiving WAP Push messages.
  35 *
  36 * @since                2.0
  37 *
  38 * The %IWapPushEventListener interface must be implemented to receive WAP Push messages. An application must register this interface using the WapPushManager::AddWapPushEventListener() method.
  39 */
  40 class _OSP_EXPORT_ IWapPushEventListener
  41         : virtual public Tizen::Base::Runtime::IEventListener
  42 {
  43 public:
  44         /**
  45         * This polymorphic destructor should be overridden if required. This way, the destructors of the derived
  46         * classes are called when the destructor of this interface is called.
  47         *
  48         * @since                2.0
  49         */
  50         virtual ~IWapPushEventListener(void) {}
  51
  52 public:
  53         /**
  54         * Called when a WAP Push message is received.
  55         *
  56         * @since                2.0
  57         *
  58         * @param[in]    message         The WAP push message
  59         */
  60         virtual void OnWapPushMessageReceived(const WapPushMessage& message) = 0;
  61
  62 protected:
  63         //
  64         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  65         //
  66         // This method is reserved and may change its name at any time without prior notice.
  67         //
  68         // @since               2.0
  69         //
  70         virtual void IWapPushEventListener_Reserved1(void) {}
  71
  72         //
  73         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  74         //
  75         // This method is reserved and may change its name at any time without prior notice.
  76         //
  77         // @since               2.0
  78         //
  79         virtual void IWapPushEventListener_Reserved2(void) {}
  80 }; // IWapPushEventListener
  81
  82 } } // Tizen::Messaging
  83 #endif // _FMSG_IWAP_PUSH_EVENT_LISTENER_H_