notification-ex/null_item.h

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef NOTIFICATION_EX_NULL_ITEM_H_
  18 #define NOTIFICATION_EX_NULL_ITEM_H_
  19
  20 #include <string>
  21 #include <memory>
  22 #include <list>
  23
  24 #include "notification-ex/abstract_item.h"
  25
  26 namespace notification {
  27 namespace item {
  28
  29 /**
  30  * @brief The class for IconTextItem type notification.
  31  * @details The NullItem is used to notify the item is null object.
  32  * @since_tizen 5.5
  33  */
  34 class EXPORT_API NullItem : public AbstractItem {
  35  public:
  36   /**
  37    * @brief Constructor
  38    * @since_tizen 5.5
  39    * @param[in] action The action for ImageItem
  40    */
  41   NullItem(std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  42
  43   /**
  44    * @brief Constructor
  45    * @since_tizen 5.5
  46    * @param[in] id The NullItem id
  47    * @param[in] action The action for ImageItem
  48    */
  49   NullItem(std::string id,
  50       std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  51
  52   /**
  53    * @brief Destructor
  54    * @since_tizen 5.5
  55    */
  56   virtual ~NullItem();
  57
  58   /**
  59    * @brief Gets the type of NullItem.
  60    * @since_tizen 5.5
  61    * @return AbstractItem::Type::NullObject
  62    */
  63   int GetType() const override;
  64
  65   /**
  66    * @brief Serialize the data of NullItem.
  67    * @since_tizen 5.5
  68    * @return Bundle type data
  69    */
  70   tizen_base::Bundle Serialize() const override;
  71
  72   /**
  73    * @brief Deserialize the serialized data.
  74    * @since_tizen 5.5
  75    * @param[in] b The serialized Bundle data
  76    */
  77   void Deserialize(tizen_base::Bundle b) override;
  78
  79   /**
  80    * @brief Checks the item type exist in this notification.
  81    * @since_tizen 5.5
  82    * @param[in] type notification item type
  83    * @return true if the item type exists
  84    */
  85   bool IsItemTypeExist(int type) override;
  86
  87   /**
  88    * @brief Finds the AbstractItem using by notification item id.
  89    * @since_tizen 5.5
  90    * @param[in] id notification item id
  91    * @return AbstractItem object
  92    */
  93   AbstractItem& FindByID(std::string id) override;
  94 };
  95
  96 }  // namespace item
  97 }  // namespace notification
  98
  99 #endif  // NOTIFICATION_EX_NULL_ITEM_H_