Class google.gdata.Feed

Object
   |
   +--google.gdata.atom.Feed
         |
         +--google.gdata.Feed

Direct Known Subclasses:

google.gdata.finance.PositionFeed, google.gdata.blogger.PostCommentFeed, google.gdata.calendar.CalendarCommentFeed, google.gdata.blogger.BlogPostFeed, google.gdata.contacts.ContactGroupFeed, google.gdata.blogger.BlogFeed, google.gdata.acl.AclFeed, google.gdata.EventFeed, google.gdata.blogger.BlogCommentFeed, google.gdata.finance.TransactionFeed, google.gdata.contacts.ContactFeed, google.gdata.calendar.CalendarFeed, google.gdata.finance.PortfolioFeed

class google.gdata.Feed

extends google.gdata.atom.Feed

Describes a feed for the Google Data API.
Defined in gdata.js

Field Detail

$entriesClass_

Object $entriesClass_

google.gdata.Feed

google.gdata.Feed(<Object> opt_params)

Constructs a Google Data API feed using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: authors, base, categories, contributors, entries, generator, id, itemsPerPage, links, logo, rights, startIndex, subTitle, title, totalResults, and updated

getEntryPostLink

google.gdata.Link|Undefined getEntryPostLink()

Returns the link that provides the URI that can be used to post new entries to the feed.

Returns:
Link that provides the URI that can be used to post new entries to the feed or undefined for none

getFeedLink

google.gdata.Link|Undefined getFeedLink()

Returns the link that provides the URI of the full feed (without any query parameters).

Returns:
Link that provides the URI of the full feed (without any query parameters) or undefined for none

getHtmlLink

google.gdata.Link|Undefined getHtmlLink()

Returns the link that provides the URI of an alternate format of the entry's or feed's contents.

Returns:
Link that provides the URI of an alternate format of the entry's or feed's contents or undefined for none

getItemsPerPage

google.gdata.opensearch.ItemsPerPage|undefined getItemsPerPage()

Returns the items-per-page count. This element is optional.

Returns:
Items-per-page count or undefined for none

getLink

google.gdata.Link|Undefined getLink(<String|Null> rel, <String> opt_type)

Returns the link of a relation and type.

Parameters:
rel - Link relation type to filter on or null to ignore
opt_type - Optional MIME type of the link target to filter on

Returns:
First link whose relation and type is a match or undefined for none

getSelf

google.gdata.Feed getSelf(<function(Object)> continuation, <function(Error)> opt_errorHandler)

Returns the current representation of the feed by requesting it from the associated service using the feed's self link.

Parameters:
continuation - Function to call on continuation. E.g.: function(entryRoot) { var entry = entryRoot.entry; };
opt_errorHandler - Function to handle error if any, e.g.: // error: an instance of Error function(error) { alert(error); };

Returns:
current representation of the feed

getSelfLink

google.gdata.Link|Undefined getSelfLink()

Returns the link that provides the URI of the feed or entry.

Returns:
Link that provides the URI of the feed or entry or undefined for none

getStartIndex

google.gdata.opensearch.StartIndex|undefined getStartIndex()

Returns the start index. This element is optional.

Returns:
Start index or undefined for none

getTotalResults

google.gdata.opensearch.TotalResults|undefined getTotalResults()

Returns the total results count. This element is optional.

Returns:
Total results count or undefined for none

insertEntry

google.gdata.Entry insertEntry(<google.gdata.Entry> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler)

Inserts a new entry into the feed.

Parameters:
entry - Entry to insert
continuation - Function to call on continuation. E.g.: function(entryRoot) { var entry = entryRoot.entry; };
opt_errorHandler - Function to handle error if any, e.g.: // error: an instance of Error function(error) { alert(error); };

Returns:
inserted entry returned by the service

setItemsPerPage

void setItemsPerPage(<google.gdata.opensearch.ItemsPerPage|Object|undefined> itemsPerPage)

Sets the items-per-page count. This element is optional.

Parameters:
itemsPerPage - Items-per-page count, or object to use as a parameter to the google.gdata.opensearch.ItemsPerPage constructor, or undefined for none

setStartIndex

void setStartIndex(<google.gdata.opensearch.StartIndex|Object|undefined> startIndex)

Sets the start index. This element is optional.

Parameters:
startIndex - Start index, or object to use as a parameter to the google.gdata.opensearch.StartIndex constructor, or undefined for none

setTotalResults

void setTotalResults(<google.gdata.opensearch.TotalResults|Object|undefined> totalResults)

Sets the total results count. This element is optional.

Parameters:
totalResults - Total results count, or object to use as a parameter to the google.gdata.opensearch.TotalResults constructor, or undefined for none