GData JavaScript Client 2.1

Class google.gdata.Feed

Object
   |
   +--google.gdata.atom.Feed
         |
         +--google.gdata.Feed
Direct Known Subclasses:
google.gdata.blogger.PostCommentFeed, google.gdata.blogger.BlogPostFeed, google.gdata.sidewiki.SidewikiEntryFeed, google.gdata.gbase.SnippetsFeed, google.gdata.MessageFeed, google.gdata.acl.AclFeed, google.gdata.EventFeed, google.gdata.gbase.MediaFeed, google.gdata.blogger.BlogCommentFeed, google.gdata.finance.TransactionFeed, google.gdata.analytics.DataFeed, google.gdata.maps.VersionFeed, google.gdata.sidewiki.SidewikiUserFeed, google.gdata.maps.FeatureFeed, google.gdata.gbase.LocalesFeed, google.gdata.gbase.ItemsFeed, google.gdata.calendar.CalendarSettingsFeed, google.gdata.finance.PositionFeed, google.gdata.calendar.CalendarCommentFeed, google.gdata.contacts.ContactGroupFeed, google.gdata.blogger.BlogFeed, google.gdata.gbase.AttributesFeed, google.gdata.maps.MapFeed, google.gdata.contacts.ContactFeed, google.gdata.analytics.AccountFeed, google.gdata.gbase.ItemTypesFeed, 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 Summary
 Object $entriesClass_
          
 Object $itemsPerPageClass_
          
 Object $startIndexClass_
          
 Object $totalResultsClass_
          
   
Fields inherited from class google.gdata.atom.Feed
$authorsClass_, $categoriesClass_, $contributorsClass_, $entriesClass_, $generatorClass_, $idClass_, $linksClass_, $logoClass_, $rightsClass_, $subtitleClass_, $titleClass_, $updatedClass_, author, category, contributor, entry, generator, id, link, logo, rights, subtitle, title, updated, xmlns
 
Constructor Summary
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.
 
Method Summary
 google.gdata.Link|Undefined getEntryPostLink()
           Returns the link that provides the URI that can be used to post new entries to the feed.
 string|undefined getEtag()
           Returns the entity tag of the feed.
 google.gdata.Link|Undefined getFeedLink()
           Returns the link that provides the URI of the full feed (without any query parameters).
 google.gdata.Link|Undefined getHtmlLink()
           Returns the link that provides the URI of an alternate format of the entry's or feed's contents.
 google.gdata.opensearch.ItemsPerPage|undefined getItemsPerPage()
           Returns the items-per-page count.
 google.gdata.Link|Undefined getLink(<string?> rel, <string> opt_type)
           Returns the link of a relation and type.
 google.gdata.Feed getSelf(<function(Object)> continuation, <function(Error)> opt_errorHandler, <Object?> opt_params)
           Returns the current representation of the feed by requesting it from the associated service using the feed's self link.
 google.gdata.Link|Undefined getSelfLink()
           Returns the link that provides the URI of the feed or entry.
 google.gdata.opensearch.StartIndex|undefined getStartIndex()
           Returns the start index.
 google.gdata.opensearch.TotalResults|undefined getTotalResults()
           Returns the total results count.
 google.gdata.Entry insertEntry(<google.gdata.Entry> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler)
           Inserts a new entry into the feed.
 void setEtag(<string|undefined> etag)
           Sets the entity tag of the feed.
 void setItemsPerPage(<google.gdata.opensearch.ItemsPerPage|Object|undefined> itemsPerPage)
           Sets the items-per-page count.
 void setStartIndex(<google.gdata.opensearch.StartIndex|Object|undefined> startIndex)
           Sets the start index.
 void setTotalResults(<google.gdata.opensearch.TotalResults|Object|undefined> totalResults)
           Sets the total results count.
 
Methods inherited from class google.gdata.atom.Feed
getAuthors, setAuthors, addAuthor, getBase, setBase, getCategories, setCategories, addCategory, getContributors, setContributors, addContributor, getEntries, setEntries, addEntry, getGenerator, setGenerator, getId, setId, getLinks, setLinks, addLink, getLogo, setLogo, getRights, setRights, getSubtitle, setSubtitle, getTitle, setTitle, getUpdated, setUpdated
 

Field Detail

$entriesClass_

Object $entriesClass_

$itemsPerPageClass_

Object $itemsPerPageClass_

$startIndexClass_

Object $startIndexClass_

$totalResultsClass_

Object $totalResultsClass_

Constructor Detail

google.gdata.Feed

google.gdata.Feed(<Object> opt_params)

Method Detail

getEntryPostLink

google.gdata.Link|Undefined getEntryPostLink()

getEtag

string|undefined getEtag()

getFeedLink

google.gdata.Link|Undefined getFeedLink()

getHtmlLink

google.gdata.Link|Undefined getHtmlLink()

getItemsPerPage

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

getLink

google.gdata.Link|Undefined getLink(<string?> rel, <string> opt_type)

getSelf

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

getSelfLink

google.gdata.Link|Undefined getSelfLink()

getStartIndex

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

getTotalResults

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

insertEntry

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

setEtag

void setEtag(<string|undefined> etag)

setItemsPerPage

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

setStartIndex

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

setTotalResults

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

GData JavaScript Client 2.1

Documentation generated by JSDoc on Mon Nov 9 14:24:07 2009