RssItem

RssItem — a RSS entry representation

Synopsis

                    RssItemPrivate;
                    RssItem;
RssItem*            rss_item_new                        (void);
const gchar*        rss_item_get_guid                   (RssItem *self);
const gchar*        rss_item_get_title                  (RssItem *self);
const gchar*        rss_item_get_link                   (RssItem *self);
const gchar*        rss_item_get_description            (RssItem *self);
const gchar*        rss_item_get_copyright              (RssItem *self);
const gchar*        rss_item_get_author_name            (RssItem *self);
const gchar*        rss_item_get_author_uri             (RssItem *self);
const gchar*        rss_item_get_author_email           (RssItem *self);
const gchar*        rss_item_get_contributor_name       (RssItem *self);
const gchar*        rss_item_get_contributor_uri        (RssItem *self);
const gchar*        rss_item_get_contributor_email      (RssItem *self);
const gchar*        rss_item_get_comments               (RssItem *self);
const gchar*        rss_item_get_pub_date               (RssItem *self);
const gchar*        rss_item_get_source                 (RssItem *self);
const gchar*        rss_item_get_source_url             (RssItem *self);
GList*              rss_item_get_categories             (RssItem *self);

Object Hierarchy

  GObject
   +----RssItem

Properties

  "author"                   gchar*                : Read / Write
  "author-email"             gchar*                : Read / Write
  "author-uri"               gchar*                : Read / Write
  "comments"                 gchar*                : Read / Write
  "contributor"              gchar*                : Read / Write
  "contributor-email"        gchar*                : Read / Write
  "contributor-uri"          gchar*                : Read / Write
  "copyright"                gchar*                : Read / Write
  "description"              gchar*                : Read / Write
  "guid"                     gchar*                : Read / Write
  "link"                     gchar*                : Read / Write
  "pub-date"                 gchar*                : Read / Write
  "source"                   gchar*                : Read / Write
  "source-url"               gchar*                : Read / Write
  "title"                    gchar*                : Read / Write

Description

RssItem is the representation of an individual item parsed from a RssDocument. This would mean an individual article, or note within the source feed.

Details

RssItemPrivate

typedef struct _RssItemPrivate RssItemPrivate;


RssItem

typedef struct _RssItem RssItem;


rss_item_new ()

RssItem*            rss_item_new                        (void);

Creates a new RssItem. This isn't incredibly useful yet as we do not have an RssGenerator written. However, that will come eventuall and make creating feeds much simpler.

Returns :

a new RssItem which should be unref'd with g_object_unref().

rss_item_get_guid ()

const gchar*        rss_item_get_guid                   (RssItem *self);

Retrieves the "guid" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_title ()

const gchar*        rss_item_get_title                  (RssItem *self);

Retrieves the "title" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_link ()

const gchar*        rss_item_get_link                   (RssItem *self);

Retrieves the "link" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_description ()

const gchar*        rss_item_get_description            (RssItem *self);

Retrieves the "description" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_copyright ()

const gchar*        rss_item_get_copyright              (RssItem *self);

Retrieves the "copyright" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_author_name ()

const gchar*        rss_item_get_author_name            (RssItem *self);

Retrieves the "author" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_author_uri ()

const gchar*        rss_item_get_author_uri             (RssItem *self);

Retrieves the "author-uri" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_author_email ()

const gchar*        rss_item_get_author_email           (RssItem *self);

Retrieves the "author-email" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_contributor_name ()

const gchar*        rss_item_get_contributor_name       (RssItem *self);

Retrieves the "contributor" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_contributor_uri ()

const gchar*        rss_item_get_contributor_uri        (RssItem *self);

Retrieves the "contributor-uri" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_contributor_email ()

const gchar*        rss_item_get_contributor_email      (RssItem *self);

Retrieves the "contributor-email" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_comments ()

const gchar*        rss_item_get_comments               (RssItem *self);

Retrieves the "comments" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_pub_date ()

const gchar*        rss_item_get_pub_date               (RssItem *self);

Retrieves the "pub-date" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_source ()

const gchar*        rss_item_get_source                 (RssItem *self);

Retrieves the "source" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_source_url ()

const gchar*        rss_item_get_source_url             (RssItem *self);

Retrieves the "source-url" field.

self :

a RssItem

Returns :

the value of the field. The returned string is owned by the RssItem and should never be modified or freed.

rss_item_get_categories ()

GList*              rss_item_get_categories             (RssItem *self);

Returns a copy of the list of categories for the RssItem. The data in the linked list are pointers to strings (char*). They are owned by the RssItem and should not be modified. Use g_strdup() to copy the individual strings.

self :

a RssItem

Returns :

a new GList which should be freed with g_list_free().

Property Details

The "author" property

  "author"                   gchar*                : Read / Write

The author's name.

Default value: NULL


The "author-email" property

  "author-email"             gchar*                : Read / Write

The authors email.

Default value: NULL


The "author-uri" property

  "author-uri"               gchar*                : Read / Write

The authors uri, often a website.

Default value: NULL


The "comments" property

  "comments"                 gchar*                : Read / Write

Any comments that may have been associated with the item.

Default value: NULL


The "contributor" property

  "contributor"              gchar*                : Read / Write

The contributors name.

Default value: NULL


The "contributor-email" property

  "contributor-email"        gchar*                : Read / Write

The contributors email.

Default value: NULL


The "contributor-uri" property

  "contributor-uri"          gchar*                : Read / Write

The contributors uri, often a website.

Default value: NULL


The "copyright" property

  "copyright"                gchar*                : Read / Write

Any associated copyright that may exist for the content.

Default value: NULL


The "description" property

  "description"              gchar*                : Read / Write

The description of the item. This is often where the actual content for the item is stored.

Default value: NULL


The "guid" property

  "guid"                     gchar*                : Read / Write

The guid of the item. Many feed engines will use the url here plus some tag metadata.

Default value: NULL


The "link" property

  "link"                     gchar*                : Read / Write

The link to the upstream source of the item.

Default value: NULL


The "pub-date" property

  "pub-date"                 gchar*                : Read / Write

The string representation of the publish date.

Default value: NULL


The "source" property

  "source"                   gchar*                : Read / Write

The name of the source of the item.

Default value: NULL


The "source-url" property

  "source-url"               gchar*                : Read / Write

The url of the source of the item.

Default value: NULL


The "title" property

  "title"                    gchar*                : Read / Write

The title of the item.

Default value: NULL