|
GData JavaScript Client 1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.atom.Feed | +--google.gdata.Feed
Describes a feed for the Google Data API.
Defined in gdata.js
Field Summary | |
Object |
$entriesClass_
|
Fields inherited from class google.gdata.atom.Feed |
$authorsClass_, $categoriesClass_, $contributorsClass_, $entriesClass_, $generatorClass_, $linksClass_, author, category, contributor, entry, generator, id, link, logo, rights, subtitle, title, updated, xmlns
|
Constructor Summary | |
google.gdata.Feed(<Object> opt_params)
Constructs a Google Data API feed using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
google.gdata.Link|Undefined
|
getEntryPostLink()
Returns the link that provides the URI that can be used to post new entries to the feed. |
google.gdata.Link|Undefined
|
getFeedLink()
Returns the link that provides the URI of the full feed (without any query parameters). |
google.gdata.Link|Undefined
|
getHtmlLink()
Returns the link that provides the URI of an alternate format of the entry's or feed's contents. |
google.gdata.opensearch.ItemsPerPage|undefined
|
getItemsPerPage()
Returns the items-per-page count. |
google.gdata.Link|Undefined
|
getLink(<String|Null> rel, <String> opt_type)
Returns the link of a relation and type. |
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 link that provides the URI of the feed or entry. |
google.gdata.opensearch.StartIndex|undefined
|
getStartIndex()
Returns the start index. |
google.gdata.opensearch.TotalResults|undefined
|
getTotalResults()
Returns the total results count. |
google.gdata.Entry
|
insertEntry(<google.gdata.Entry> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler)
Inserts a new entry into the feed. |
void
|
setItemsPerPage(<google.gdata.opensearch.ItemsPerPage|Object|undefined> itemsPerPage)
Sets the items-per-page count. |
void
|
setStartIndex(<google.gdata.opensearch.StartIndex|Object|undefined> startIndex)
Sets the start index. |
void
|
setTotalResults(<google.gdata.opensearch.TotalResults|Object|undefined> totalResults)
Sets the total results count. |
Methods inherited from class google.gdata.atom.Feed |
getAuthors, setAuthors, addAuthor, getBase, setBase, getCategories, setCategories, addCategory, getContributors, setContributors, addContributor, getEntries, setEntries, addEntry, getGenerator, setGenerator, getId, setId, getLinks, setLinks, addLink, getLogo, setLogo, getRights, setRights, getSubTitle, setSubTitle, getTitle, setTitle, getUpdated, setUpdated
|
Field Detail |
Object $entriesClass_
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, base, categories, contributors, entries, generator, id, itemsPerPage, links, logo, rights, startIndex, subTitle, title, totalResults, and updated
Method Detail |
google.gdata.Link|Undefined getEntryPostLink()
google.gdata.Link|Undefined getFeedLink()
google.gdata.Link|Undefined getHtmlLink()
google.gdata.opensearch.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
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.opensearch.StartIndex|undefined getStartIndex()
google.gdata.opensearch.TotalResults|undefined getTotalResults()
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 setItemsPerPage(<google.gdata.opensearch.ItemsPerPage|Object|undefined> itemsPerPage)
itemsPerPage
- Items-per-page count, or object to use as a parameter to the google.gdata.opensearch.ItemsPerPage constructor, or undefined for none
void setStartIndex(<google.gdata.opensearch.StartIndex|Object|undefined> startIndex)
startIndex
- Start index, or object to use as a parameter to the google.gdata.opensearch.StartIndex constructor, or undefined for none
void setTotalResults(<google.gdata.opensearch.TotalResults|Object|undefined> totalResults)
totalResults
- Total results count, or object to use as a parameter to the google.gdata.opensearch.TotalResults constructor, or undefined for none
|
GData JavaScript Client 1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |