Opml Class Reference

Represents a collection of feeds, typically exported from a feed reader. More...

#include <opml.hpp>

Public Member Functions
	Opml (std::string path, bool essentials_only=false)
	Constructs the Opml object from a valid OPML file path.
std::vector< OpmlItem >	get_items ()
	Retrieve the OpmlItem objects that have been parsed.
std::string	to_json ()
	Represents the Opml object (itself) as a json, returned as a string.

Detailed Description

Represents a collection of feeds, typically exported from a feed reader.

Upon construction it will try its best to parse useful information out of the provided file.

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

Constructor & Destructor Documentation

Opml()

Opml::Opml ( std::string  path, bool  essentials_only = false  )

inline

Constructs the Opml object from a valid OPML file path.

It will also automatically construct a vector of OpmlItem objects representing the various feeds found in the collection.

Parameters

path	a valid file path to an RSS or Atom XML file.
essentials_only	can optionally be 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. This option will be passed to the constructor of OpmlItem.

Member Function Documentation

get_items()

std::vector< OpmlItem > Opml::get_items ( )

inline

Retrieve the OpmlItem objects that have been parsed.

to_json()

std::string Opml::to_json

(

)

Represents the Opml object (itself) as a json, returned as a string.

---

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

• src/opml.hpp
• src/opml.cpp