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 Detail

author

Array.<google.gdata.Person> author

Authors.

category

Array.<google.gdata.Category> category

Categories.

contributor

Array.<google.gdata.Person> contributor

Contributors.

entry

Array.<google.gdata.Entry> entry

Entries.

generator

google.gdata.Generator|Undefined generator

Generator. This element is optional.

id

google.gdata.Id|Undefined id

Feed identifier. This element is required.

link

Array.<google.gdata.Link> link

Links.

subtitle

google.gdata.Text|Undefined subtitle

Subtitle. This element is required.

title

google.gdata.Text|Undefined title

Title. This element is required.

updated

google.gdata.Updated|Undefined updated

Updated timestamp. This element is required.

xmlns

<final> String xmlns

Atom (ATOM) namespace.

google.gdata.Feed

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.

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

addAuthor

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

Adds a new author.

Parameters:
author - Author to add, or object to use as a parameter to the google.gdata.Person constructor

addCategory

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

Adds a new category.

Parameters:
category - Category to add, or object to use as a parameter to the google.gdata.Category constructor

addContributor

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

Adds a new contributor.

Parameters:
contributor - Contributor to add, or object to use as a parameter to the google.gdata.Person constructor

addEntry

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

Adds a new entry.

Parameters:
entry - Entry to add, or object to use as a parameter to the google.gdata.Entry constructor

addLink

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

Adds a new link.

Parameters:
link - Link to add, or object to use as a parameter to the google.gdata.Link constructor

getAuthors

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

Returns the authors.

Returns:
Authors

getCategories

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

Returns the categories.

Returns:
Categories

getContributors

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

Returns the contributors.

Returns:
Contributors

getEntries

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

Returns the entries.

Returns:
Entries

getEntryClass

Object getEntryClass()

Returns the class to use for representing atom:entry. Override to use an extension of google.gdata.Entry.

Returns:
Class to use for representing atom:entry

getEntryPostLink

google.gdata.Link|Undefined getEntryPostLink()

Returns the entry post link.

Returns:
Entry post link or undefined for none

getFeedLink

google.gdata.Link|Undefined getFeedLink()

Returns the feed link.

Returns:
Feed link or undefined for none

getGenerator

google.gdata.Generator|Undefined getGenerator()

Returns the generator. This element is optional.

Returns:
Generator or undefined for none

getHtmlLink

google.gdata.Link|Undefined getHtmlLink()

Returns the html link.

Returns:
Html link or undefined for none

getId

google.gdata.Id|Undefined getId()

Returns the feed identifier. This element is required.

Returns:
Feed identifier or undefined for none

getItemsPerPage

google.gdata.ItemsPerPage|Undefined getItemsPerPage()

Returns the items per page. This element is optional.

Returns:
Items per page 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

getLinkClass

Object getLinkClass()

Returns the class to use for representing atom:link. Override to use an extension of google.gdata.Link.

Returns:
Class to use for representing atom:link

getLinks

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

Returns the links.

Returns:
Links

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 self link.

Returns:
Self link or undefined for none

getStartIndex

google.gdata.StartIndex|Undefined getStartIndex()

Returns the start index. This element is optional.

Returns:
Start index or undefined for none

getSubTitle

google.gdata.Text|Undefined getSubTitle()

Returns the subtitle. This element is required.

Returns:
Subtitle or undefined for none

getTitle

google.gdata.Text|Undefined getTitle()

Returns the title. This element is required.

Returns:
Title or undefined for none

getTotalResults

google.gdata.TotalResults|Undefined getTotalResults()

Returns the total results. This element is optional.

Returns:
Total results or undefined for none

getUpdated

google.gdata.Updated|Undefined getUpdated()

Returns the updated timestamp. This element is required.

Returns:
Updated timestamp 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

setAuthors

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

Sets the authors.

Parameters:
authors - Authors, where each author is added using the addAuthor() function, or undefined to clear the authors

setCategories

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

Sets the categories.

Parameters:
categories - Categories, where each category is added using the addCategory() function, or undefined to clear the categories

setContributors

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

Sets the contributors.

Parameters:
contributors - Contributors, where each contributor is added using the addContributor() function, or undefined to clear the contributors

setEntries

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

Sets the entries.

Parameters:
entries - Entries, where each entry is added using the addEntry() function, or undefined to clear the entries

setGenerator

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

Sets the generator. This element is optional.

Parameters:
generator - Generator, or object to use as a parameter to the google.gdata.Generator constructor, or undefined for none

setId

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

Sets the feed identifier. This element is required.

Parameters:
id - Feed identifier, or object to use as a parameter to the google.gdata.Id constructor, or undefined for none

setItemsPerPage

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

Sets the items per page. This element is optional.

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

setLinks

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

Sets the links.

Parameters:
links - Links, where each link is added using the addLink() function, or undefined to clear the links

setStartIndex

void setStartIndex(<google.gdata.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.StartIndex constructor, or undefined for none

setSubTitle

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

Sets the subtitle. This element is required.

Parameters:
subTitle - Subtitle, or object to use as a parameter to the google.gdata.Text constructor, or undefined for none

setTitle

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

Sets the title. This element is required.

Parameters:
title - Title, or object to use as a parameter to the google.gdata.Text constructor, or undefined for none

setTotalResults

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

Sets the total results. This element is optional.

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

setUpdated

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

Sets the updated timestamp. This element is required.

Parameters:
updated - Updated timestamp, or object to use as a parameter to the google.gdata.Updated constructor, or undefined for none