Class google.gdata.atom.Entry

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

Direct Known Subclasses:

google.gdata.Entry

class google.gdata.atom.Entry

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

Field Detail

$authorsClass_

Object $authorsClass_

$categoriesClass_

Object $categoriesClass_

$contentClass_

Object $contentClass_

$contributorsClass_

Object $contributorsClass_

$idClass_

Object $idClass_

$linksClass_

Object $linksClass_

$publishedClass_

Object $publishedClass_

$rightsClass_

Object $rightsClass_

$summaryClass_

Object $summaryClass_

$titleClass_

Object $titleClass_

$updatedClass_

Object $updatedClass_

author

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

Authors.

category

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

Categories.

content

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

Content. This element is optional.

contributor

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

Contributors.

id

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

Entry identifier. This element is required.

link

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

Links.

published

{google.gdata.atom.Published|undefined} published

Creation timestamp. This element is optional.

rights

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

Rights. This element is optional.

summary

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

Summary. 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.Entry

google.gdata.atom.Entry(<Object> opt_params)

Constructs an entry 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, content, contributors, id, links, published, rights, summary, 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.

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.

getCategories

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

Returns the categories.

Returns:
Categories.

getCategoryClass

Object getCategoryClass()

getContent

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

Returns the content. This element is optional.

Returns:
Content or undefined for none.

getContributors

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

Returns the contributors.

Returns:
Contributors.

getId

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

Returns the entry identifier. This element is required.

Returns:
Entry identifier or undefined for none.

getLinkClass

Object getLinkClass()

getLinks

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

Returns the links.

Returns:
Links.

getPublished

google.gdata.atom.Published|undefined getPublished()

Returns the creation timestamp. This element is optional.

Returns:
Creation timestamp or undefined for none.

getRights

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

Returns the rights. This element is optional.

Returns:
Rights or undefined for none.

getSummary

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

Returns the summary. This element is optional.

Returns:
Summary 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.

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.

setContent

void setContent(<google.gdata.atom.Text|Object|undefined> content)

Sets the content. This element is optional.

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

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.

setId

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

Sets the entry identifier. This element is required.

Parameters:
id - Entry 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.

setPublished

void setPublished(<google.gdata.atom.Published|Object|undefined> published)

Sets the creation timestamp. This element is optional.

Parameters:
published - Creation timestamp, or object to use as a parameter to the google.gdata.atom.Published 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.

setSummary

void setSummary(<google.gdata.atom.Text|Object|undefined> summary)

Sets the summary. This element is optional.

Parameters:
summary - Summary, 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.