GData.Feed¶

Subclasses:: GData.CalendarFeed, GData.DocumentsFeed, GData.PicasaWebFeed, GData.YouTubeFeed

Methods¶

Inherited:: GData.Parsable (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_authors` ()
	`get_categories` ()
	`get_entries` ()
	`get_etag` ()
	`get_generator` ()
	`get_icon` ()
	`get_id` ()
	`get_items_per_page` ()
	`get_links` ()
	`get_logo` ()
	`get_next_page_token` ()
	`get_rights` ()
	`get_start_index` ()
	`get_subtitle` ()
	`get_title` ()
	`get_total_results` ()
	`get_updated` ()
	`look_up_entry` (id)
	`look_up_link` (rel)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7)

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`etag`	`str`	r	The unique ETag for this version of the feed.
`generator`	`GData.Generator`	r	Details of the software used to generate the feed.
`icon`	`str`	r	The URI of an icon for the feed.
`id`	`str`	r	The unique and permanent URN ID for the feed.
`items-per-page`	`int`	r	The number of items per results page feed.
`logo`	`str`	r	The URI of a logo for the feed.
`next-page-token`	`str`	r	The next page token for feeds.
`rights`	`str`	r	The ownership rights pertaining to the entire feed.
`start-index`	`int`	r	The one-based index of the first item in the results feed.
`subtitle`	`str`	r	The subtitle of the feed.
`title`	`str`	r	The title of the feed.
`total-results`	`int`	r	The total number of results in the feed.
`updated`	`int`	r	The time the feed was last updated.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.Feed(**kwargs)¶

Bases:: GData.Parsable
Abstract:: No
Structure:: GData.FeedClass

All the fields in the GData.Feed structure are private and should never be accessed directly.

get_authors()¶

Returns:: a GLib.List of GData.Authors
Return type:: [GData.Author]

Returns a list of the authors listed in this feed.

get_categories()¶

Returns:: a GLib.List of GData.Categorys
Return type:: [GData.Category]

Returns a list of the categories listed in this feed.

get_entries()¶

Returns:: a GLib.List of GData.Entrys
Return type:: [GData.Entry]

Returns a list of the entries contained in this feed.

get_etag()¶

Returns:: the feed’s ETag
Return type:: str

Returns the feed’s unique ETag for this version.

New in version 0.2.0.

get_generator()¶

Returns:: a GData.Generator, or None
Return type:: GData.Generator

Returns details about the software which generated the feed.

get_icon()¶

Returns:: the feed’s icon URI, or None
Return type:: str

Returns the icon URI of the feed.

New in version 0.6.0.

get_id()¶

Returns:: the feed’s ID
Return type:: str

Returns the feed’s unique and permanent URN ID.

get_items_per_page()¶

Returns:: the number of items per results page feed, or 0
Return type:: int

Returns the number of items per results page feed.

get_links()¶

Returns:: a GLib.List of GData.Links
Return type:: [GData.Link]

Returns a list of the links listed in this feed.

get_logo()¶

Returns:: the feed’s logo URI, or None
Return type:: str

Returns the logo URI of the feed.

get_next_page_token()¶

Returns:: the next page token
Return type:: str or None

Returns the next page token for a query result, or None if not set. This is GData.Feed :next-page-token. The page token might not be set if there is no next page, or if this service does not use token based paging (for example, if it uses page number or offset based paging instead). Most more recent services use token based paging.

New in version 0.17.7.

get_rights()¶

Returns:: the feed’s rights information
Return type:: str

Returns the rights pertaining to the entire feed, or None if not set.

New in version 0.7.0.

get_start_index()¶

Returns:: the one-based start index, or 0
Return type:: int

Returns the one-based start index of the results feed in the result set.

get_subtitle()¶

Returns:: the feed’s subtitle, or None
Return type:: str

Returns the subtitle of the feed.

get_title()¶

Returns:: the feed’s title
Return type:: str

Returns the title of the feed.

get_total_results()¶

Returns:: the total number of results, or 0
Return type:: int

Returns the total number of results in the result set, including results on other pages. If this is zero, the total number is unknown.

get_updated()¶

Returns:: the UNIX timestamp for the time the feed was last updated
Return type:: int

Gets the time the feed was last updated.

look_up_entry(id)¶

Parameters:: id (str) – the entry’s ID
Returns:: the GData.Entry, or None
Return type:: GData.Entry

Returns the entry in the feed with the given id, if found.

New in version 0.2.0.

look_up_link(rel)¶

Parameters:: rel (str) – the value of the GData.Link :relation-type property of the desired link
Returns:: a GData.Link, or None if one was not found
Return type:: GData.Link

Looks up a link by GData.Link :relation-type value from the list of links in the feed.

New in version 0.1.1.

Property Details¶

GData.Feed.props.etag¶

Name:: etag
Type:: str
Default Value:: None
Flags:: READABLE

The unique ETag for this version of the feed. See the

online documentation for more information.

New in version 0.2.0.

GData.Feed.props.generator¶

Name:: generator
Type:: GData.Generator
Default Value:: None
Flags:: READABLE

Details of the software used to generate the feed.

API reference: atom:generator

GData.Feed.props.icon¶

Name:: icon
Type:: str
Default Value:: None
Flags:: READABLE

The URI of an icon for the feed.

API reference:

atom:icon

New in version 0.6.0.

GData.Feed.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE

The unique and permanent URN ID for the feed.

API reference: atom:id

GData.Feed.props.items_per_page¶

Name:: items-per-page
Type:: int
Default Value:: 0
Flags:: READABLE

The number of items per results page feed.

API reference:

openSearch:itemsPerPage

GData.Feed.props.logo¶

Name:: logo
Type:: str
Default Value:: None
Flags:: READABLE

The URI of a logo for the feed.

API reference: atom:logo

GData.Feed.props.next_page_token¶

Name:: next-page-token
Type:: str
Default Value:: None
Flags:: READABLE

The next page token for feeds. Pass this to gdata_query_set_page_token() to advance to the next page when querying APIs which use page tokens rather than page numbers or offsets.

New in version 0.17.7.

GData.Feed.props.rights¶

Name:: rights
Type:: str
Default Value:: None
Flags:: READABLE

The ownership rights pertaining to the entire feed.

For more information, see the Atom specification.

New in version 0.7.0.

GData.Feed.props.start_index¶

Name:: start-index
Type:: int
Default Value:: 1
Flags:: READABLE

The one-based index of the first item in the results feed.

This should not be used manually for pagination. Instead, use a GData.Query and call its GData.Query.next_page() or GData.Query.previous_page() functions before making the query to the service.

API reference: openSearch:startIndex

GData.Feed.props.subtitle¶

Name:: subtitle
Type:: str
Default Value:: None
Flags:: READABLE

The subtitle of the feed.

API reference: atom:subtitle

GData.Feed.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE

The title of the feed.

API reference:

atom:title

GData.Feed.props.total_results¶

Name:: total-results
Type:: int
Default Value:: 0
Flags:: READABLE

The number of items in the result set for the feed, including those on other pages. If this is zero, the total number is unknown.

This should not be used manually for pagination. Instead, use a GData.Query and call its GData.Query.next_page() or GData.Query.previous_page() functions before making the query to the service.

API reference:

openSearch:totalResults

GData.Feed.props.updated¶

Name:: updated
Type:: int
Default Value:: 0
Flags:: READABLE

The time the feed was last updated.

API reference: atom:updated