Class google.gdata.app.Categories

Object
   |
   +--google.gdata.app.Categories

class google.gdata.app.Categories

Value of the app:categories tag.
Defined in gdata.js

Field Detail

$categoriesClass_

Object $categoriesClass_

category

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

Categories.

fixed

{string|undefined} fixed

Indicates whether the list of categories is a fixed or an open set. This attribute is optional.

href

{string|undefined} href

An IRI reference to a Category Document. This attribute is optional.

scheme

{string|undefined} scheme

Default scheme of the contained category elements. This attribute is optional.

FIXED_NO

<static> <final> {string} FIXED_NO

Is not fixed.

See Also:

Constant Field Values

FIXED_YES

<static> <final> {string} FIXED_YES

Is fixed.

See Also:

Constant Field Values

google.gdata.app.Categories

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.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: categories, fixed, href, and scheme.

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.

getCategories

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

Returns the categories.

Returns:
Categories.

getFixed

string|undefined getFixed()

Returns the indicates whether the list of categories is a fixed or an open set. This attribute is optional.

Returns:
Indicates whether the list of categories is a fixed or an open set or undefined for none.

getHref

string|undefined getHref()

Returns the an IRI reference to a Category Document. This attribute is optional.

Returns:
An IRI reference to a Category Document or undefined for none.

getScheme

string|undefined getScheme()

Returns the default scheme of the contained category elements. This attribute is optional.

Returns:
Default scheme of the contained category elements or undefined for none.

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.

setFixed

void setFixed(<string|undefined> fixed)

Sets the indicates whether the list of categories is a fixed or an open set. This attribute is optional.

Parameters:
fixed - Indicates whether the list of categories is a fixed or an open set or undefined for none.

setHref

void setHref(<string|undefined> href)

Sets the an IRI reference to a Category Document. This attribute is optional.

Parameters:
href - An IRI reference to a Category Document or undefined for none.

setScheme

void setScheme(<string|undefined> scheme)

Sets the default scheme of the contained category elements. This attribute is optional.

Parameters:
scheme - Default scheme of the contained category elements or undefined for none.