GData JavaScript Client 1.0

Class google.gdata.Feed

Object
   |
   +--google.gdata.Feed
Direct Known Subclasses:
google.gdata.calendar.CalendarCommentFeed, google.gdata.calendar.CalendarFeed, google.gdata.calendar.CalendarEventFeed, google.gdata.AclFeed

class google.gdata.Feed


Describes the base class for a GData feed.
Defined in gdata.js


Field Summary
 Array.<google.gdata.Person> author
          Authors.
 Array.<google.gdata.Category> category
          Categories.
 Array.<google.gdata.Person> contributor
          Contributors.
 Array.<google.gdata.Entry> entry
          Entries.
 google.gdata.Generator|Undefined generator
          Generator.
 google.gdata.Id|Undefined id
          Feed identifier.
 Array.<google.gdata.Link> link
          Links.
 google.gdata.Text|Undefined subtitle
          Subtitle.
 google.gdata.Text|Undefined title
          Title.
 google.gdata.Updated|Undefined updated
          Updated timestamp.
 <final> String xmlns
          Atom (ATOM) namespace.
 
Constructor Summary
google.gdata.Feed(<Object> opt_params)
            Constructs a feed using an object parameter whose property names match the setter method to use for each property.
 
Method Summary
 void addAuthor(<google.gdata.Person|Object> author)
           Adds a new author.
 void addCategory(<google.gdata.Category|Object> category)
           Adds a new category.
 void addContributor(<google.gdata.Person|Object> contributor)
           Adds a new contributor.
 void addEntry(<google.gdata.Entry|Object> entry)
           Adds a new entry.
 void addLink(<google.gdata.Link|Object> link)
           Adds a new link.
 Array.<google.gdata.Person> getAuthors()
           Returns the authors.
 Array.<google.gdata.Category> getCategories()
           Returns the categories.
 Array.<google.gdata.Person> getContributors()
           Returns the contributors.
 Array.<google.gdata.Entry> getEntries()
           Returns the entries.
 Object getEntryClass()
           Returns the class to use for representing atom:entry.
 google.gdata.Link|Undefined getEntryPostLink()
           Returns the entry post link.
 google.gdata.Link|Undefined getFeedLink()
           Returns the feed link.
 google.gdata.Generator|Undefined getGenerator()
           Returns the generator.
 google.gdata.Link|Undefined getHtmlLink()
           Returns the html link.
 google.gdata.Id|Undefined getId()
           Returns the feed identifier.
 google.gdata.ItemsPerPage|Undefined getItemsPerPage()
           Returns the items per page.
 google.gdata.Link|Undefined getLink(<String|Null> rel, <String> opt_type)
           Returns the link of a relation and type.
 Object getLinkClass()
           Returns the class to use for representing atom:link.
 Array.<google.gdata.Link> getLinks()
           Returns the links.
 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.
 google.gdata.Link|Undefined getSelfLink()
           Returns the self link.
 google.gdata.StartIndex|Undefined getStartIndex()
           Returns the start index.
 google.gdata.Text|Undefined getSubTitle()
           Returns the subtitle.
 google.gdata.Text|Undefined getTitle()
           Returns the title.
 google.gdata.TotalResults|Undefined getTotalResults()
           Returns the total results.
 google.gdata.Updated|Undefined getUpdated()
           Returns the updated timestamp.
 google.gdata.Entry insertEntry(<google.gdata.Entry> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler)
           Inserts a new entry into the feed.
 void setAuthors(<Array.<google.gdata.Person>|Array.<Object>|Undefined> authors)
           Sets the authors.
 void setCategories(<Array.<google.gdata.Category>|Array.<Object>|Undefined> categories)
           Sets the categories.
 void setContributors(<Array.<google.gdata.Person>|Array.<Object>|Undefined> contributors)
           Sets the contributors.
 void setEntries(<Array.<google.gdata.Entry>|Array.<Object>|Undefined> entries)
           Sets the entries.
 void setGenerator(<google.gdata.Generator|Object|Undefined> generator)
           Sets the generator.
 void setId(<google.gdata.Id|Object|Undefined> id)
           Sets the feed identifier.
 void setItemsPerPage(<google.gdata.ItemsPerPage|Object|Undefined> itemsPerPage)
           Sets the items per page.
 void setLinks(<Array.<google.gdata.Link>|Array.<Object>|Undefined> links)
           Sets the links.
 void setStartIndex(<google.gdata.StartIndex|Object|Undefined> startIndex)
           Sets the start index.
 void setSubTitle(<google.gdata.Text|Object|Undefined> subTitle)
           Sets the subtitle.
 void setTitle(<google.gdata.Text|Object|Undefined> title)
           Sets the title.
 void setTotalResults(<google.gdata.TotalResults|Object|Undefined> totalResults)
           Sets the total results.
 void setUpdated(<google.gdata.Updated|Object|Undefined> updated)
           Sets the updated timestamp.

Field Detail

author

Array.<google.gdata.Person> author

category

Array.<google.gdata.Category> category

contributor

Array.<google.gdata.Person> contributor

entry

Array.<google.gdata.Entry> entry

generator

google.gdata.Generator|Undefined generator

id

google.gdata.Id|Undefined id

link

Array.<google.gdata.Link> link

subtitle

google.gdata.Text|Undefined subtitle

title

google.gdata.Text|Undefined title

updated

google.gdata.Updated|Undefined updated

xmlns

<final> String xmlns

Constructor Detail

google.gdata.Feed

google.gdata.Feed(<Object> opt_params)

Method Detail

addAuthor

void addAuthor(<google.gdata.Person|Object> author)

addCategory

void addCategory(<google.gdata.Category|Object> category)

addContributor

void addContributor(<google.gdata.Person|Object> contributor)

addEntry

void addEntry(<google.gdata.Entry|Object> entry)

addLink

void addLink(<google.gdata.Link|Object> link)

getAuthors

Array.<google.gdata.Person> getAuthors()

getCategories

Array.<google.gdata.Category> getCategories()

getContributors

Array.<google.gdata.Person> getContributors()

getEntries

Array.<google.gdata.Entry> getEntries()

getEntryClass

Object getEntryClass()

getEntryPostLink

google.gdata.Link|Undefined getEntryPostLink()

getFeedLink

google.gdata.Link|Undefined getFeedLink()

getGenerator

google.gdata.Generator|Undefined getGenerator()

getHtmlLink

google.gdata.Link|Undefined getHtmlLink()

getId

google.gdata.Id|Undefined getId()

getItemsPerPage

google.gdata.ItemsPerPage|Undefined getItemsPerPage()

getLink

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

getLinkClass

Object getLinkClass()

getLinks

Array.<google.gdata.Link> getLinks()

getSelf

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

getSelfLink

google.gdata.Link|Undefined getSelfLink()

getStartIndex

google.gdata.StartIndex|Undefined getStartIndex()

getSubTitle

google.gdata.Text|Undefined getSubTitle()

getTitle

google.gdata.Text|Undefined getTitle()

getTotalResults

google.gdata.TotalResults|Undefined getTotalResults()

getUpdated

google.gdata.Updated|Undefined getUpdated()

insertEntry

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

setAuthors

void setAuthors(<Array.<google.gdata.Person>|Array.<Object>|Undefined> authors)

setCategories

void setCategories(<Array.<google.gdata.Category>|Array.<Object>|Undefined> categories)

setContributors

void setContributors(<Array.<google.gdata.Person>|Array.<Object>|Undefined> contributors)

setEntries

void setEntries(<Array.<google.gdata.Entry>|Array.<Object>|Undefined> entries)

setGenerator

void setGenerator(<google.gdata.Generator|Object|Undefined> generator)

setId

void setId(<google.gdata.Id|Object|Undefined> id)

setItemsPerPage

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

setLinks

void setLinks(<Array.<google.gdata.Link>|Array.<Object>|Undefined> links)

setStartIndex

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

setSubTitle

void setSubTitle(<google.gdata.Text|Object|Undefined> subTitle)

setTitle

void setTitle(<google.gdata.Text|Object|Undefined> title)

setTotalResults

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

setUpdated

void setUpdated(<google.gdata.Updated|Object|Undefined> updated)

GData JavaScript Client 1.0

Documentation generated by JSDoc on Fri Sep 14 16:32:36 2007