|
GData JavaScript Client 1.7 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.atom.Feed
Describes the base class for a GData feed.
Defined in gdata.js
Field Summary | |
Object |
$authorsClass_
|
Object |
$categoriesClass_
|
Object |
$contributorsClass_
|
Object |
$entriesClass_
|
Object |
$generatorClass_
|
Object |
$idClass_
|
Object |
$linksClass_
|
Object |
$logoClass_
|
Object |
$rightsClass_
|
Object |
$subTitleClass_
|
Object |
$titleClass_
|
Object |
$updatedClass_
|
{Array.<google.gdata.atom.Person>} |
author
Authors. |
{Array.<google.gdata.atom.Category>} |
category
Categories. |
{Array.<google.gdata.atom.Person>} |
contributor
Contributors. |
{Array.<google.gdata.atom.Entry>} |
entry
Entries. |
{google.gdata.atom.Generator|undefined} |
generator
Generator. |
{google.gdata.atom.Id|undefined} |
id
Feed identifier. |
{Array.<google.gdata.atom.Link>} |
link
Links. |
{google.gdata.atom.Logo|undefined} |
logo
Logo. |
{google.gdata.atom.Text|undefined} |
rights
Rights. |
{google.gdata.atom.Text|undefined} |
subtitle
Subtitle. |
{google.gdata.atom.Text|undefined} |
title
Title. |
{google.gdata.atom.Updated|undefined} |
updated
Updated timestamp. |
<final> {string} |
xmlns
Atom (ATOM) namespace. |
Constructor Summary | |
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. |
Method Summary | |
void
|
addAuthor(<google.gdata.atom.Person|Object> author)
Adds a new author. |
void
|
addCategory(<google.gdata.atom.Category|Object> category)
Adds a new category. |
void
|
addContributor(<google.gdata.atom.Person|Object> contributor)
Adds a new contributor. |
void
|
addEntry(<google.gdata.atom.Entry|Object> entry)
Adds a new entry. |
void
|
addLink(<google.gdata.atom.Link|Object> link)
Adds a new link. |
Array.<google.gdata.atom.Person>
|
getAuthors()
Returns the authors. |
string|undefined
|
getBase()
Returns the base. |
Array.<google.gdata.atom.Category>
|
getCategories()
Returns the categories. |
Array.<google.gdata.atom.Person>
|
getContributors()
Returns the contributors. |
Array.<google.gdata.atom.Entry>
|
getEntries()
Returns the entries. |
google.gdata.atom.Generator|undefined
|
getGenerator()
Returns the generator. |
google.gdata.atom.Id|undefined
|
getId()
Returns the feed identifier. |
Array.<google.gdata.atom.Link>
|
getLinks()
Returns the links. |
google.gdata.atom.Logo|undefined
|
getLogo()
Returns the logo. |
google.gdata.atom.Text|undefined
|
getRights()
Returns the rights. |
google.gdata.atom.Text|undefined
|
getSubTitle()
Returns the subtitle. |
google.gdata.atom.Text|undefined
|
getTitle()
Returns the title. |
google.gdata.atom.Updated|undefined
|
getUpdated()
Returns the updated timestamp. |
void
|
setAuthors(<Array.<google.gdata.atom.Person>|Array.<Object>|undefined> authors)
Sets the authors. |
void
|
setBase(<string|undefined> base)
Sets the base. |
void
|
setCategories(<Array.<google.gdata.atom.Category>|Array.<Object>|undefined> categories)
Sets the categories. |
void
|
setContributors(<Array.<google.gdata.atom.Person>|Array.<Object>|undefined> contributors)
Sets the contributors. |
void
|
setEntries(<Array.<google.gdata.atom.Entry>|Array.<Object>|undefined> entries)
Sets the entries. |
void
|
setGenerator(<google.gdata.atom.Generator|Object|undefined> generator)
Sets the generator. |
void
|
setId(<google.gdata.atom.Id|Object|undefined> id)
Sets the feed identifier. |
void
|
setLinks(<Array.<google.gdata.atom.Link>|Array.<Object>|undefined> links)
Sets the links. |
void
|
setLogo(<google.gdata.atom.Logo|Object|undefined> logo)
Sets the logo. |
void
|
setRights(<google.gdata.atom.Text|Object|undefined> rights)
Sets the rights. |
void
|
setSubTitle(<google.gdata.atom.Text|Object|undefined> subTitle)
Sets the subtitle. |
void
|
setTitle(<google.gdata.atom.Text|Object|undefined> title)
Sets the title. |
void
|
setUpdated(<google.gdata.atom.Updated|Object|undefined> updated)
Sets the updated timestamp. |
Field Detail |
Object $authorsClass_
Object $categoriesClass_
Object $contributorsClass_
Object $entriesClass_
Object $generatorClass_
Object $idClass_
Object $linksClass_
Object $logoClass_
Object $rightsClass_
Object $subTitleClass_
Object $titleClass_
Object $updatedClass_
{Array.<google.gdata.atom.Person>} author
{Array.<google.gdata.atom.Category>} category
{Array.<google.gdata.atom.Person>} contributor
{Array.<google.gdata.atom.Entry>} entry
{google.gdata.atom.Generator|undefined} generator
{google.gdata.atom.Id|undefined} id
{Array.<google.gdata.atom.Link>} link
{google.gdata.atom.Logo|undefined} logo
{google.gdata.atom.Text|undefined} rights
{google.gdata.atom.Text|undefined} subtitle
{google.gdata.atom.Text|undefined} title
{google.gdata.atom.Updated|undefined} updated
<final> {string} xmlns
Constructor Detail |
google.gdata.atom.Feed(<Object> opt_params)
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.
Method Detail |
void addAuthor(<google.gdata.atom.Person|Object> author)
author
- Author to add, or object to use as a parameter to the google.gdata.atom.Person constructor.
void addCategory(<google.gdata.atom.Category|Object> category)
category
- Category to add, or object to use as a parameter to the google.gdata.atom.Category constructor.
void addContributor(<google.gdata.atom.Person|Object> contributor)
contributor
- Contributor to add, or object to use as a parameter to the google.gdata.atom.Person constructor.
void addEntry(<google.gdata.atom.Entry|Object> entry)
entry
- Entry to add, or object to use as a parameter to the google.gdata.atom.Entry constructor.
void addLink(<google.gdata.atom.Link|Object> link)
link
- Link to add, or object to use as a parameter to the google.gdata.atom.Link constructor.
Array.<google.gdata.atom.Person> getAuthors()
string|undefined getBase()
Array.<google.gdata.atom.Category> getCategories()
Array.<google.gdata.atom.Person> getContributors()
Array.<google.gdata.atom.Entry> getEntries()
google.gdata.atom.Generator|undefined getGenerator()
google.gdata.atom.Id|undefined getId()
Array.<google.gdata.atom.Link> getLinks()
google.gdata.atom.Logo|undefined getLogo()
google.gdata.atom.Text|undefined getRights()
google.gdata.atom.Text|undefined getSubTitle()
google.gdata.atom.Text|undefined getTitle()
google.gdata.atom.Updated|undefined getUpdated()
void setAuthors(<Array.<google.gdata.atom.Person>|Array.<Object>|undefined> authors)
authors
- Authors, where each author is added using the addAuthor() function, or undefined to clear the authors.
void setBase(<string|undefined> base)
base
- Base or undefined for none.
void setCategories(<Array.<google.gdata.atom.Category>|Array.<Object>|undefined> categories)
categories
- Categories, where each category is added using the addCategory() function, or undefined to clear the categories.
void setContributors(<Array.<google.gdata.atom.Person>|Array.<Object>|undefined> contributors)
contributors
- Contributors, where each contributor is added using the addContributor() function, or undefined to clear the contributors.
void setEntries(<Array.<google.gdata.atom.Entry>|Array.<Object>|undefined> entries)
entries
- Entries, where each entry is added using the addEntry() function, or undefined to clear the entries.
void setGenerator(<google.gdata.atom.Generator|Object|undefined> generator)
generator
- Generator, or object to use as a parameter to the google.gdata.atom.Generator constructor, or undefined for none.
void setId(<google.gdata.atom.Id|Object|undefined> id)
id
- Feed identifier, or object to use as a parameter to the google.gdata.atom.Id constructor, or undefined for none.
void setLinks(<Array.<google.gdata.atom.Link>|Array.<Object>|undefined> links)
links
- Links, where each link is added using the addLink() function, or undefined to clear the links.
void setLogo(<google.gdata.atom.Logo|Object|undefined> logo)
logo
- Logo, or object to use as a parameter to the google.gdata.atom.Logo constructor, or undefined for none.
void setRights(<google.gdata.atom.Text|Object|undefined> rights)
rights
- Rights, or object to use as a parameter to the google.gdata.atom.Text constructor, or undefined for none.
void setSubTitle(<google.gdata.atom.Text|Object|undefined> subTitle)
subTitle
- Subtitle, or object to use as a parameter to the google.gdata.atom.Text constructor, or undefined for none.
void setTitle(<google.gdata.atom.Text|Object|undefined> title)
title
- Title, or object to use as a parameter to the google.gdata.atom.Text constructor, or undefined for none.
void setUpdated(<google.gdata.atom.Updated|Object|undefined> updated)
updated
- Updated timestamp, or object to use as a parameter to the google.gdata.atom.Updated constructor, or undefined for none.
|
GData JavaScript Client 1.7 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |