inc/FMsgIEtwsPrimaryNotificationEventListener.h

   1 //\r
   2 // Open Service Platform\r
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.\r
   4 //\r
   5 // Licensed under the Apache License, Version 2.0 (the License);\r
   6 // you may not use this file except in compliance with the License.\r
   7 // You may obtain a copy of the License at\r
   8 //\r
   9 //     http://www.apache.org/licenses/LICENSE-2.0\r
  10 //\r
  11 // Unless required by applicable law or agreed to in writing, software\r
  12 // distributed under the License is distributed on an "AS IS" BASIS,\r
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14 // See the License for the specific language governing permissions and\r
  15 // limitations under the License.\r
  16 //\r
  17 /**\r
  18 * @file                 FMsgIEtwsPrimaryNotificationEventListener.h\r
  19 * @brief                This is the header file for the %IEtwsPrimaryNotificationEventListener interface.\r
  20 *\r
  21 * This header file contains the declarations of the %IEtwsPrimaryNotificationEventListener interface.\r
  22 */\r
  23 \r
  24 #ifndef _FMSG_IETWS_PRIMARY_NOTIFICATION_EVENT_LISTENER_H_\r
  25 #define _FMSG_IETWS_PRIMARY_NOTIFICATION_EVENT_LISTENER_H_\r
  26 \r
  27 #include <FMsgICbsMessageEventListener.h>\r
  28 \r
  29 namespace Tizen { namespace Messaging\r
  30 {\r
  31         class EtwsPrimaryNotification;\r
  32 \r
  33         /**\r
  34         * @interface    IEtwsPrimaryNotificationEventListener\r
  35         * @brief                This is the listener interface for receiving ETWS primary notification.\r
  36         *\r
  37         * @since                2.0\r
  38         *\r
  39         * The %IEtwsPrimaryNotificationEventListener interface must be implemented to handle incoming ETWS primary notification.\r
  40         * An application must register this interface using the SmsManager::SetEtwsPrimaryNotificationEventListener() method.\r
  41         */\r
  42         class _OSP_EXPORT_ IEtwsPrimaryNotificationEventListener\r
  43                 : virtual public Tizen::Messaging::ICbsMessageEventListener\r
  44         {\r
  45         public:\r
  46                 /**\r
  47                 * This polymorphic destructor should be overridden if required. @n\r
  48                 * This way, the destructors of the derived classes are called when the destructor of this interface is called.\r
  49 \r
  50                 *\r
  51                 * @since                2.0\r
  52                 */\r
  53                 virtual ~IEtwsPrimaryNotificationEventListener(void) {}\r
  54 \r
  55                 /**\r
  56                 * Called when the ETWS primary notification is received.\r
  57                 *\r
  58                 * @since                2.0\r
  59                 *\r
  60                 * @param[in]    message                 The ETWS primary notification that is received\r
  61                 * @see                  SmsManager::SetEtwsPrimaryNotificationEventListener()\r
  62                 */\r
  63                 virtual void OnEtwsPrimaryNotificationReceived(const EtwsPrimaryNotification& message) = 0;\r
  64 \r
  65         protected:\r
  66                 //\r
  67                 // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.\r
  68                 //\r
  69                 // This method is reserved and may change its name at any time without prior notice.\r
  70                 //\r
  71                 // @since               2.0\r
  72                 //\r
  73                 virtual void IEtwsPrimaryNotificationEventListener_Reserved1(void) {}\r
  74 \r
  75                 //\r
  76                 // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.\r
  77                 //\r
  78                 // This method is reserved and may change its name at any time without prior notice.\r
  79                 //\r
  80                 // @since               2.0\r
  81                 //\r
  82                 virtual void IEtwsPrimaryNotificationEventListener_Reserved2(void) {}\r
  83         }; // IEtwsPrimaryNotificationEventListener\r
  84 } } // Tizen::Messaging\r
  85 #endif // _FMSG_IETWS_PRIMARY_NOTIFICATION_EVENT_LISTENER_H_\r