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