OpmlItem Class Reference

Represents a single feed extracted from an OPML file. More...

#include <opml_item.hpp>

Public Member Functions
	OpmlItem (xml_node item_node, bool essentials_only=false, std::vector< std::string > additional_categories={})
	Constructs the OpmlItem object from a pugi::xml_node representing an item in an OPML file.
std::string	get_text ()
	Not applicable for a valid OpmlItem, gets the value of the text attribute in case the current outline is a container for other outlines.
std::string	get_title ()
std::string	get_description ()
std::string	get_url ()
std::string	get_feed_url ()
std::vector< std::string >	get_categories ()
std::string	get_type ()
std::string	get_language ()
std::string	to_json ()

Detailed Description

Represents a single feed extracted from an OPML file.

Typically you won't need to manually initialzie OpmlItem objects, you can instead create an Opml object and extract its OpmlItems using Opml::get_items().

In case some value cannot be found, it will just contain an empty string.

Constructor & Destructor Documentation

OpmlItem()

OpmlItem::OpmlItem ( xml_node  item_node, bool  essentials_only = false, std::vector< std::string >  additional_categories = {}  )

inline

Constructs the OpmlItem object from a pugi::xml_node representing an item in an OPML file.

Parameters

item_node	a pugi::xml_node object representing an item inside an OPML body.
essentials_only	can be optionally set to true to just parse the feed url and the categories list; this can be done if the other values are not needed and can result in a small performance boost.

Member Function Documentation

get_categories()

std::vector< std::string > OpmlItem::get_categories ( )

inline

get_description()

std::string OpmlItem::get_description ( )

inline

get_feed_url()

std::string OpmlItem::get_feed_url ( )

inline

get_language()

std::string OpmlItem::get_language ( )

inline

get_text()

std::string OpmlItem::get_text

(

)

Not applicable for a valid OpmlItem, gets the value of the text attribute in case the current outline is a container for other outlines.

get_title()

std::string OpmlItem::get_title ( )

inline

get_type()

std::string OpmlItem::get_type ( )

inline

get_url()

std::string OpmlItem::get_url ( )

inline

to_json()

std::string OpmlItem::to_json

(

)

---

The documentation for this class was generated from the following files:

• src/opml_item.hpp
• src/opml_item.cpp