Class google.gdata.atom.Feed

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

Direct Known Subclasses:

google.gdata.Feed

class google.gdata.atom.Feed

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

Field Detail

$authorsClass_

Object $authorsClass_

$categoriesClass_

Object $categoriesClass_

$contributorsClass_

Object $contributorsClass_

$entriesClass_

Object $entriesClass_

$generatorClass_

Object $generatorClass_

$idClass_

Object $idClass_

$linksClass_

Object $linksClass_

$logoClass_

Object $logoClass_

$rightsClass_

Object $rightsClass_

$subTitleClass_

Object $subTitleClass_

$titleClass_

Object $titleClass_

$updatedClass_

Object $updatedClass_

author

{Array.<google.gdata.atom.Person>} author

Authors.

category

{Array.<google.gdata.atom.Category>} category

Categories.

contributor

{Array.<google.gdata.atom.Person>} contributor

Contributors.

entry

{Array.<google.gdata.atom.Entry>} entry

Entries.

generator

{google.gdata.atom.Generator|undefined} generator

Generator. This element is optional.

id

{google.gdata.atom.Id|undefined} id

Feed identifier. This element is required.

link

{Array.<google.gdata.atom.Link>} link

Links.

logo

{google.gdata.atom.Logo|undefined} logo

Logo. This element is optional.

rights

{google.gdata.atom.Text|undefined} rights

Rights. This element is optional.

subtitle

{google.gdata.atom.Text|undefined} subtitle

Subtitle. This element is optional.

title

{google.gdata.atom.Text|undefined} title

Title. This element is required.

updated

{google.gdata.atom.Updated|undefined} updated

Updated timestamp. This element is required.

xmlns

<final> {string} xmlns

Atom (ATOM) namespace.

google.gdata.atom.Feed

google.gdata.atom.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, base, categories, contributors, entries, generator, id, links, logo, rights, subTitle, title, and updated.

addAuthor

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

Adds a new author.

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

addCategory

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

Adds a new category.

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

addContributor

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

Adds a new contributor.

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

addEntry

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

Adds a new entry.

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

addLink

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

Adds a new link.

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

getAuthors

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

Returns the authors.

Returns:
Authors.

getBase

string|undefined getBase()

Returns the base. This attribute is optional.

Returns:
Base or undefined for none.

getCategories

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

Returns the categories.

Returns:
Categories.

getContributors

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

Returns the contributors.

Returns:
Contributors.

getEntries

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

Returns the entries.

Returns:
Entries.

getGenerator

google.gdata.atom.Generator|undefined getGenerator()

Returns the generator. This element is optional.

Returns:
Generator or undefined for none.

getId

google.gdata.atom.Id|undefined getId()

Returns the feed identifier. This element is required.

Returns:
Feed identifier or undefined for none.

getLinks

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

Returns the links.

Returns:
Links.

getLogo

google.gdata.atom.Logo|undefined getLogo()

Returns the logo. This element is optional.

Returns:
Logo or undefined for none.

getRights

google.gdata.atom.Text|undefined getRights()

Returns the rights. This element is optional.

Returns:
Rights or undefined for none.

getSubTitle

google.gdata.atom.Text|undefined getSubTitle()

Returns the subtitle. This element is optional.

Returns:
Subtitle or undefined for none.

getTitle

google.gdata.atom.Text|undefined getTitle()

Returns the title. This element is required.

Returns:
Title or undefined for none.

getUpdated

google.gdata.atom.Updated|undefined getUpdated()

Returns the updated timestamp. This element is required.

Returns:
Updated timestamp or undefined for none.

setAuthors

void setAuthors(<Array.<google.gdata.atom.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.

setBase

void setBase(<string|undefined> base)

Sets the base. This attribute is optional.

Parameters:
base - Base or undefined for none.

setCategories

void setCategories(<Array.<google.gdata.atom.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.atom.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.atom.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.atom.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.atom.Generator constructor, or undefined for none.

setId

void setId(<google.gdata.atom.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.atom.Id constructor, or undefined for none.

setLinks

void setLinks(<Array.<google.gdata.atom.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.

setLogo

void setLogo(<google.gdata.atom.Logo|Object|undefined> logo)

Sets the logo. This element is optional.

Parameters:
logo - Logo, or object to use as a parameter to the google.gdata.atom.Logo constructor, or undefined for none.

setRights

void setRights(<google.gdata.atom.Text|Object|undefined> rights)

Sets the rights. This element is optional.

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

setSubTitle

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

Sets the subtitle. This element is optional.

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

setTitle

void setTitle(<google.gdata.atom.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.atom.Text constructor, or undefined for none.

setUpdated

void setUpdated(<google.gdata.atom.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.atom.Updated constructor, or undefined for none.