| Rss-GLib Reference Manual | ||||
|---|---|---|---|---|
RssDocumentPrivate;
RssDocument;
RssDocument* rss_document_new (void);
const gchar* rss_document_get_guid (RssDocument *self);
const gchar* rss_document_get_about (RssDocument *self);
const gchar* rss_document_get_title (RssDocument *self);
const gchar* rss_document_get_description (RssDocument *self);
const gchar* rss_document_get_link (RssDocument *self);
const gchar* rss_document_get_encoding (RssDocument *self);
const gchar* rss_document_get_language (RssDocument *self);
const gchar* rss_document_get_rating (RssDocument *self);
const gchar* rss_document_get_copyright (RssDocument *self);
const gchar* rss_document_get_pub_date (RssDocument *self);
const gchar* rss_document_get_editor_name (RssDocument *self);
const gchar* rss_document_get_editor_email (RssDocument *self);
const gchar* rss_document_get_editor_uri (RssDocument *self);
const gchar* rss_document_get_contributor_name (RssDocument *self);
const gchar* rss_document_get_contributor_email (RssDocument *self);
const gchar* rss_document_get_contributor_uri (RssDocument *self);
const gchar* rss_document_get_generator_name (RssDocument *self);
const gchar* rss_document_get_generator_uri (RssDocument *self);
const gchar* rss_document_get_generator_version (RssDocument *self);
const gchar* rss_document_get_image_title (RssDocument *self);
const gchar* rss_document_get_image_url (RssDocument *self);
const gchar* rss_document_get_image_link (RssDocument *self);
gint rss_document_get_ttl (RssDocument *self);
GList* rss_document_get_items (RssDocument *self);
GList* rss_document_get_categories (RssDocument *self);
"about" 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 "editor" gchar* : Read / Write "editor-email" gchar* : Read / Write "editor-uri" gchar* : Read / Write "encoding" gchar* : Read / Write "generator" gchar* : Read / Write "generator-uri" gchar* : Read / Write "generator-version" gchar* : Read / Write "guid" gchar* : Read / Write "image-link" gchar* : Read / Write "image-title" gchar* : Read / Write "image-url" gchar* : Read / Write "language" gchar* : Read / Write "link" gchar* : Read / Write "pub-date" gchar* : Read / Write "rating" gchar* : Read / Write "title" gchar* : Read / Write "ttl" gint : Read / Write
RssDocument is the representation of the resource that was parsed. It contains a list of RssItems which in turn contain article information.
RssDocument* rss_document_new (void);
Creates a new instance of RssDocument. This isn't incredibly useful currently, but is here none-the-less. The desire is to create an RSS generator that will allow for building RSS streams out of the document hierarchy.
Returns : |
a new RssDocument. Use g_object_unref() when you are done.
|
const gchar* rss_document_get_guid (RssDocument *self);
Retrieves the "guid" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_about (RssDocument *self);
Retrieves the "about" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_title (RssDocument *self);
Retrieves the "title" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_description (RssDocument *self);
Retrieves the "description" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_link (RssDocument *self);
Retrieves the "link" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_encoding (RssDocument *self);
Retrieves the "encoding" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_language (RssDocument *self);
Retrieves the "language" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_rating (RssDocument *self);
Retrieves the "rating" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_copyright (RssDocument *self);
Retrieves the "copyright" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_pub_date (RssDocument *self);
Retrieves the "pub-date" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_editor_name (RssDocument *self);
Retrieves the "editor" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_editor_email (RssDocument *self);
Retrieves the "editor-email" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_editor_uri (RssDocument *self);
Retrieves the "editor-uri" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_contributor_name (RssDocument *self);
|
|
Returns : |
const gchar* rss_document_get_contributor_email (RssDocument *self);
Retrieves the "contributor-email" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_contributor_uri (RssDocument *self);
Retrieves the "contributor-uri" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_generator_name (RssDocument *self);
Retrieves the "generator-name" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_generator_uri (RssDocument *self);
Retrieves the "generator-uri" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_generator_version (RssDocument *self);
Retrieves the "generator-version" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_image_title (RssDocument *self);
Retrieves the "image-title" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_image_url (RssDocument *self);
Retrieves the "image-url" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
const gchar* rss_document_get_image_link (RssDocument *self);
Retrieves the "image-link" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
gint rss_document_get_ttl (RssDocument *self);
Retrieves the "ttl" field.
|
a RssDocument |
Returns : |
the contents of the field. The returned string is owned by the RssDocument and should never be modified of freed |
GList* rss_document_get_items (RssDocument *self);
Creates a GList of RssItems that were found in the syndication. The objects in the list are weak references. Consumers of those objects should ref them with g_object_ref.
|
a RssDocument |
Returns : |
a new GList owned by the caller. |
GList* rss_document_get_categories (RssDocument *self);
Creates a GList of categories found in the syndication. The strings
in the list are weak references. Consumers should duplicate them
with g_strdup().
|
a RssDocument |
Returns : |
a new GList owned by the caller |
"about" property"about" gchar* : Read / Write
Information about the RssDocument.
Default value: NULL
"contributor" property"contributor" gchar* : Read / Write
The name of the particular contributor.
Default value: NULL
"contributor-email" property"contributor-email" gchar* : Read / Write
The email of the particular contributor.
Default value: NULL
"contributor-uri" property"contributor-uri" gchar* : Read / Write
The uri to more information on the particular contributer.
Default value: NULL
"copyright" property"copyright" gchar* : Read / Write
The copyright of the RssDocument.
Default value: NULL
"description" property"description" gchar* : Read / Write
The description of the RssDocument.
Default value: NULL
"editor-email" property"editor-email" gchar* : Read / Write
The email address of the editor.
Default value: NULL
"editor-uri" property"editor-uri" gchar* : Read / Write
The uri for more information about the editor.
Default value: NULL
"encoding" property"encoding" gchar* : Read / Write
The encoding of the RssDocument.
Default value: NULL
"generator" property"generator" gchar* : Read / Write
The name of the generator on the server side.
Default value: NULL
"generator-uri" property"generator-uri" gchar* : Read / Write
Url to more information about the generator on the server side.
Default value: NULL
"generator-version" property"generator-version" gchar* : Read / Write
The version of the server side generator.
Default value: NULL
"guid" property"guid" gchar* : Read / Write
The guid associated with the feed. This is often the url of the feed.
Default value: NULL
"image-link" property"image-link" gchar* : Read / Write
The url a user should be redirected to when clicking on the image for the RssDocument. Of course, its up to UI designers if they wish to implement this in any sort of way.
Default value: NULL
"image-title" property"image-title" gchar* : Read / Write
The title for the image. This is often the alt="" tag in HTML.
Default value: NULL
"image-url" property"image-url" gchar* : Read / Write
A url to the image for the RssDocument. Use this before checking for a favicon.ico.
Default value: NULL
"language" property"language" gchar* : Read / Write
The language the RssDocument was published in.
Default value: NULL
"link" property"link" gchar* : Read / Write
The link to the source document. This is parsed from the actual document and can point to whatever the source publisher choses.
Default value: NULL
"pub-date" property"pub-date" gchar* : Read / Write
The string representation of the date the document was published.
Default value: NULL
"rating" property"rating" gchar* : Read / Write
The rating associated with the RssDocument.
Default value: NULL
"title" property"title" gchar* : Read / Write
The title of the RssDocument.
Default value: NULL
"ttl" property"ttl" gint : Read / Write
The publisher determined TTL for the source. Readers should try to respect this value and not update feeds any more often than necessary.
Allowed values: >= 0
Default value: 0