Check priv_id of item_info when update
[platform/core/api/notification.git] / notification-ex / icon_text_item.h
index 9a3330e..224aa63 100644 (file)
 namespace notification {
 namespace item {
 
+/**
+ * @brief The class for IconTextItem type notification.
+ * @details The class to make the notification with icon and text.
+ * @since_tizen 5.5
+ */
 class EXPORT_API IconTextItem : public AbstractItem {
  public:
+  /**
+   * @brief Constructor
+   * @since_tizen 5.5
+   * @param[in] id The IconTextItem id
+   * @param[in] icon The icon of IconTextItem
+   * @param[in] text The text of IconTextItem
+   * @param[in] action The action for IconTextItem
+   */
   IconTextItem(std::string id, std::shared_ptr<IconItem> icon,
     std::shared_ptr<TextItem> text,
     std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
 
+  /**
+   * @brief Destructor
+   * @since_tizen 5.5
+   */
   virtual ~IconTextItem();
 
-  Bundle Serialize() const override;
-  void Deserialize(Bundle b) override;
+  /**
+   * @brief Serialize the data of IconTextItem.
+   * @since_tizen 5.5
+   * @return Bundle type data
+   */
+  tizen_base::Bundle Serialize() const override;
+
+  /**
+   * @brief Deserialize the serialized data.
+   * @since_tizen 5.5
+   * @param[in] b The serialized Bundle data
+   */
+  void Deserialize(tizen_base::Bundle b) override;
+
+  /**
+   * @brief Finds the AbstractItem using by notification item id.
+   * @since_tizen 5.5
+   * @param[in] id notification item id
+   * @return AbstractItem object
+   */
   AbstractItem& FindByID(std::string id) override;
+
+  /**
+   * @brief Finds the AbstractItem using by main type.
+   * @since_tizen 5.5
+   * @param[in] type The main type
+   * @return AbstractItem object
+   */
+  AbstractItem& FindByMainType(MainType type) override;
+
+  /**
+   * @brief Checks the item type exist in this notification.
+   * @since_tizen 5.5
+   * @param[in] type notification item type
+   * @return true if the item type exists
+   */
+  bool IsItemTypeExist(int type) override;
+
+  /**
+   * @brief Gets the type of IconTextItem.
+   * @since_tizen 5.5
+   * @return AbstractItem::Type::IconText
+   */
   int GetType() const override;
 
+  /**
+   * @brief Gets the IconItem of IconTextItem.
+   * @since_tizen 5.5
+   * @return The IconItem object
+   */
   IconItem& GetIconItem() const;
+
+  /**
+   * @brief Gets the TextItem of IconTextItem.
+   * @since_tizen 5.5
+   * @return The TextItem object
+   */
   TextItem& GetTextItem() const;
 
  private: