|
GData JavaScript Client 2.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.app.Categories
Value of the app:categories tag.
Defined in gdata.js
Field Summary | |
Object |
$categoriesClass_
|
{Array.<google.gdata.atom.Category>} |
category
Categories. |
{string|undefined} |
fixed
Indicates whether the list of categories is a fixed or an open set. |
{string|undefined} |
href
An IRI reference to a Category Document. |
{string|undefined} |
scheme
Default scheme of the contained category elements. |
<static> <final> {string} |
FIXED_NO
Is not fixed. |
<static> <final> {string} |
FIXED_YES
Is fixed. |
Constructor Summary | |
google.gdata.app.Categories(<Object> opt_params)
Constructs an app categories document using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
void
|
addCategory(<google.gdata.atom.Category|Object> category)
Adds a new category. |
Array.<google.gdata.atom.Category>
|
getCategories()
Returns the categories. |
string|undefined
|
getFixed()
Returns the indicates whether the list of categories is a fixed or an open set. |
string|undefined
|
getHref()
Returns the an IRI reference to a Category Document. |
string|undefined
|
getScheme()
Returns the default scheme of the contained category elements. |
void
|
setCategories(<Array.<google.gdata.atom.Category>|Array.<Object>|undefined> categories)
Sets the categories. |
void
|
setFixed(<string|undefined> fixed)
Sets the indicates whether the list of categories is a fixed or an open set. |
void
|
setHref(<string|undefined> href)
Sets the an IRI reference to a Category Document. |
void
|
setScheme(<string|undefined> scheme)
Sets the default scheme of the contained category elements. |
Field Detail |
Object $categoriesClass_
{Array.<google.gdata.atom.Category>} category
{string|undefined} fixed
{string|undefined} href
{string|undefined} scheme
<static> <final> {string} FIXED_NO
<static> <final> {string} FIXED_YES
Constructor Detail |
google.gdata.app.Categories(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: categories, fixed, href, and scheme.
Method Detail |
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.
Array.<google.gdata.atom.Category> getCategories()
string|undefined getFixed()
string|undefined getHref()
string|undefined getScheme()
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 setFixed(<string|undefined> fixed)
fixed
- Indicates whether the list of categories is a fixed or an open set or undefined for none.
void setHref(<string|undefined> href)
href
- An IRI reference to a Category Document or undefined for none.
void setScheme(<string|undefined> scheme)
scheme
- Default scheme of the contained category elements or undefined for none.
|
GData JavaScript Client 2.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |