|
GData JavaScript Client 1.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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 |
Array.<google.gdata.Person> author
Array.<google.gdata.Category> category
Array.<google.gdata.Person> contributor
Array.<google.gdata.Entry> entry
google.gdata.Generator|Undefined generator
google.gdata.Id|Undefined id
Array.<google.gdata.Link> link
google.gdata.Text|Undefined subtitle
google.gdata.Text|Undefined title
google.gdata.Updated|Undefined updated
<final> String xmlns
Constructor Detail |
google.gdata.Feed(<Object> opt_params)
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
Method Detail |
void addAuthor(<google.gdata.Person|Object> author)
author
- Author to add, or object to use as a parameter to the google.gdata.Person constructor
void addCategory(<google.gdata.Category|Object> category)
category
- Category to add, or object to use as a parameter to the google.gdata.Category constructor
void addContributor(<google.gdata.Person|Object> contributor)
contributor
- Contributor to add, or object to use as a parameter to the google.gdata.Person constructor
void addEntry(<google.gdata.Entry|Object> entry)
entry
- Entry to add, or object to use as a parameter to the google.gdata.Entry constructor
void addLink(<google.gdata.Link|Object> link)
link
- Link to add, or object to use as a parameter to the google.gdata.Link constructor
Array.<google.gdata.Person> getAuthors()
Array.<google.gdata.Category> getCategories()
Array.<google.gdata.Person> getContributors()
Array.<google.gdata.Entry> getEntries()
Object getEntryClass()
google.gdata.Link|Undefined getEntryPostLink()
google.gdata.Link|Undefined getFeedLink()
google.gdata.Generator|Undefined getGenerator()
google.gdata.Link|Undefined getHtmlLink()
google.gdata.Id|Undefined getId()
google.gdata.ItemsPerPage|Undefined getItemsPerPage()
google.gdata.Link|Undefined getLink(<String|Null> rel, <String> opt_type)
rel
- Link relation type to filter on or null to ignore
opt_type
- Optional MIME type of the link target to filter on
Object getLinkClass()
Array.<google.gdata.Link> getLinks()
google.gdata.Feed getSelf(<function(Object)> continuation, <function(Error)> opt_errorHandler)
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); };
google.gdata.Link|Undefined getSelfLink()
google.gdata.StartIndex|Undefined getStartIndex()
google.gdata.Text|Undefined getSubTitle()
google.gdata.Text|Undefined getTitle()
google.gdata.TotalResults|Undefined getTotalResults()
google.gdata.Updated|Undefined getUpdated()
google.gdata.Entry insertEntry(<google.gdata.Entry> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler)
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); };
void setAuthors(<Array.<google.gdata.Person>|Array.<Object>|Undefined> authors)
authors
- Authors, where each author is added using the addAuthor() function, or undefined to clear the authors
void setCategories(<Array.<google.gdata.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.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.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.Generator|Object|Undefined> generator)
generator
- Generator, or object to use as a parameter to the google.gdata.Generator constructor, or undefined for none
void setId(<google.gdata.Id|Object|Undefined> id)
id
- Feed identifier, or object to use as a parameter to the google.gdata.Id constructor, or undefined for none
void setItemsPerPage(<google.gdata.ItemsPerPage|Object|Undefined> itemsPerPage)
itemsPerPage
- Items per page, or object to use as a parameter to the google.gdata.ItemsPerPage constructor, or undefined for none
void setLinks(<Array.<google.gdata.Link>|Array.<Object>|Undefined> links)
links
- Links, where each link is added using the addLink() function, or undefined to clear the links
void setStartIndex(<google.gdata.StartIndex|Object|Undefined> startIndex)
startIndex
- Start index, or object to use as a parameter to the google.gdata.StartIndex constructor, or undefined for none
void setSubTitle(<google.gdata.Text|Object|Undefined> subTitle)
subTitle
- Subtitle, or object to use as a parameter to the google.gdata.Text constructor, or undefined for none
void setTitle(<google.gdata.Text|Object|Undefined> title)
title
- Title, or object to use as a parameter to the google.gdata.Text constructor, or undefined for none
void setTotalResults(<google.gdata.TotalResults|Object|Undefined> totalResults)
totalResults
- Total results, or object to use as a parameter to the google.gdata.TotalResults constructor, or undefined for none
void setUpdated(<google.gdata.Updated|Object|Undefined> updated)
updated
- Updated timestamp, or object to use as a parameter to the google.gdata.Updated constructor, or undefined for none
|
GData JavaScript Client 1.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |