GrssFeedsGroup

GrssFeedsGroup — import and export group of channels

Synopsis

struct              GrssFeedsGroup;
GrssFeedsGroup *    grss_feeds_group_new                ();
GList *             grss_feeds_group_get_formats        (GrssFeedsGroup *group);
GList *             grss_feeds_group_parse_file         (GrssFeedsGroup *group,
                                                         const gchar *path,
                                                         GError **error);
gboolean            grss_feeds_group_export_file        (GrssFeedsGroup *group,
                                                         GList *channels,
                                                         const gchar *format,
                                                         const gchar *uri,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GrssFeedsGroup

Description

GrssFeedsGroup is an utility to read and write lists of GrssFeedChannels in different formats, such as OPML and XOXO.

Details

struct GrssFeedsGroup

struct GrssFeedsGroup;

grss_feeds_group_new ()

GrssFeedsGroup *    grss_feeds_group_new                ();

Allocates a new GrssFeedsGroup.

Returns :

a new GrssFeedsGroup.

grss_feeds_group_get_formats ()

GList *             grss_feeds_group_get_formats        (GrssFeedsGroup *group);

Returns the list of supported file formats.

`group` :	a GrssFeedsGroup.
Returns :	a list of constant strings with names of supported formats. The list must be freed when no longer used

grss_feeds_group_parse_file ()

GList *             grss_feeds_group_parse_file         (GrssFeedsGroup *group,
                                                         const gchar *path,
                                                         GError **error);

Parses the given file to obtain list of listed feeds.

`group` :	a GrssFeedsGroup.
`path` :	path of the file to parse.
`error` :	location for eventual errors.
Returns :	a list of GrssFeedChannels, or NULL if an error occours and `error` is set.

grss_feeds_group_export_file ()

gboolean            grss_feeds_group_export_file        (GrssFeedsGroup *group,
                                                         GList *channels,
                                                         const gchar *format,
                                                         const gchar *uri,
                                                         GError **error);

Creates a new file with the list of channels rappresented in the required format. It a file already exists at the uri location, it is overwritten.

`group` :	a GrssFeedsGroup.
`channels` :	list of GrssFeedChannels.
`format` :	string rappresenting the desired export format, as returnes by `grss_feeds_group_get_formats()`.
`uri` :	URI of the file to write.
`error` :	location for eventual errors.
Returns :	`TRUE` if the file is created correctly, or `FALSE` if an error occours and `error` is set.

			libgrss Reference Manual
Top \| Description \| Object Hierarchy