|
|
|
GData Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#include <gdata/gdata-feed.h>
GDataFeed;
GDataFeedClass;
const gchar * gdata_feed_get_title (GDataFeed *self);
const gchar * gdata_feed_get_subtitle (GDataFeed *self);
const gchar * gdata_feed_get_id (GDataFeed *self);
GList * gdata_feed_get_authors (GDataFeed *self);
GList * gdata_feed_get_categories (GDataFeed *self);
GList * gdata_feed_get_entries (GDataFeed *self);
GDataGenerator * gdata_feed_get_generator (GDataFeed *self);
GList * gdata_feed_get_links (GDataFeed *self);
GDataLink * gdata_feed_look_up_link (GDataFeed *self,
const gchar *rel);
const gchar * gdata_feed_get_logo (GDataFeed *self);
void gdata_feed_get_updated (GDataFeed *self,
GTimeVal *updated);
guint gdata_feed_get_start_index (GDataFeed *self);
guint gdata_feed_get_total_results (GDataFeed *self);
guint gdata_feed_get_items_per_page (GDataFeed *self);
"generator" gpointer : Read / Write / Construct Only "id" gchar* : Read / Write / Construct Only "items-per-page" guint : Read / Write / Construct Only "logo" gchar* : Read / Write / Construct Only "start-index" guint : Read / Write / Construct Only "subtitle" gchar* : Read / Write / Construct Only "title" gchar* : Read / Write / Construct Only "total-results" guint : Read / Write / Construct Only "updated" GTimeVal* : Read / Write / Construct Only
GDataFeed is a list of entries (GDataEntry) returned as the result of a query to a GDataService, or given as the input to another operation on the online service. It also has pieces of data associated with the query on the GDataService, such as the query title or timestamp when it was last updated.
Each GDataEntry represents a single object on the online service, such as a playlist, video or calendar entry, and the GDataFeed represents a collection of similar objects.
typedef struct _GDataFeed GDataFeed;
All the fields in the GDataFeed structure are private and should never be accessed directly.
typedef struct {
} GDataFeedClass;
All the fields in the GDataFeedClass structure are private and should never be accessed directly.
const gchar * gdata_feed_get_title (GDataFeed *self);
Returns the title of the feed.
|
a GDataFeed |
Returns : |
the feed's title |
const gchar * gdata_feed_get_subtitle (GDataFeed *self);
Returns the subtitle of the feed.
const gchar * gdata_feed_get_id (GDataFeed *self);
Returns the feed's unique and permanent URN ID.
|
a GDataFeed |
Returns : |
the feed's ID |
GList * gdata_feed_get_authors (GDataFeed *self);
Returns a list of the authors listed in this feed.
|
a GDataFeed |
Returns : |
a GList of GDataAuthors; free the list with g_list_free(), but do not free the authors
|
GList * gdata_feed_get_categories (GDataFeed *self);
Returns a list of the categories listed in this feed.
|
a GDataFeed |
Returns : |
a GList of GDataCategorys; free the list with g_list_free(), but do not free the categories
|
GList * gdata_feed_get_entries (GDataFeed *self);
Returns a list of the entries contained in this feed.
|
a GDataFeed |
Returns : |
a GList of GDataEntrys; free the list with g_list_free(), but do not unref the entries
|
GDataGenerator * gdata_feed_get_generator (GDataFeed *self);
Returns details about the software which generated the feed.
|
a GDataFeed |
Returns : |
a GDataGenerator, or NULL
|
GList * gdata_feed_get_links (GDataFeed *self);
Returns a list of the links listed in this feed.
GDataLink * gdata_feed_look_up_link (GDataFeed *self, const gchar *rel);
Looks up a link by rel value from the list of links in the feed.
const gchar * gdata_feed_get_logo (GDataFeed *self);
Returns the logo URI of the feed.
void gdata_feed_get_updated (GDataFeed *self, GTimeVal *updated);
Puts the time the feed was last updated into updated.
|
a GDataFeed |
|
a GTimeVal |
guint gdata_feed_get_start_index (GDataFeed *self);
Returns the one-based start index of the results feed in the result set.
|
a GDataFeed |
Returns : |
the one-based start index, or 0 on error |
guint gdata_feed_get_total_results (GDataFeed *self);
Returns the total number of results in the result set, including results on other pages.
|
a GDataFeed |
Returns : |
the total number of results, or 0 on error |
"generator" property"generator" gpointer : Read / Write / Construct Only
Details of the software used to generate the feed.
API reference: atom:generator
"id" property"id" gchar* : Read / Write / Construct Only
The unique and permanent URN ID for the feed.
API reference: atom:id
Default value: NULL
"items-per-page" property"items-per-page" guint : Read / Write / Construct Only
The number of items per results page feed.
API reference: openSearch:itemsPerPage
Allowed values: <= G_MAXINT
Default value: 0
"logo" property"logo" gchar* : Read / Write / Construct Only
The URI of a logo for the feed.
API reference: atom:logo
Default value: NULL
"start-index" property"start-index" guint : Read / Write / Construct Only
The one-based index of the first item in the results feed.
This should not be used manually for pagination. Instead, use a GDataQuery and call its gdata_query_next_page()
or gdata_query_previous_page() functions before making the query to the service.
API reference: openSearch:startIndex
Allowed values: [1,G_MAXINT]
Default value: 1
"subtitle" property"subtitle" gchar* : Read / Write / Construct Only
The subtitle of the feed.
API reference: atom:subtitle
Default value: NULL
"title" property"title" gchar* : Read / Write / Construct Only
The title of the feed.
API reference: atom:title
Default value: NULL
"total-results" property"total-results" guint : Read / Write / Construct Only
The number of items in the result set for the feed, including those on other pages.
This should not be used manually for pagination. Instead, use a GDataQuery and call its gdata_query_next_page()
or gdata_query_previous_page() functions before making the query to the service.
API reference: openSearch:totalResults
Allowed values: <= 1000000
Default value: 0
"updated" property"updated" GTimeVal* : Read / Write / Construct Only
The time the feed was last updated.
API reference: atom:updated