Class google.gdata.sidewiki.SidewikiAuthor

Object
   |
   +--google.gdata.atom.Person
         |
         +--google.gdata.sidewiki.SidewikiAuthor

class google.gdata.sidewiki.SidewikiAuthor

extends google.gdata.atom.Person

Sidewiki author.
Defined in gdata.js

Field Detail

$descriptionClass_

Object $descriptionClass_

$numEntriesClass_

Object $numEntriesClass_

$ratingClass_

Object $ratingClass_

$resourceIdClass_

Object $resourceIdClass_

$thumbnailClass_

Object $thumbnailClass_

google.gdata.sidewiki.SidewikiAuthor

google.gdata.sidewiki.SidewikiAuthor(<Object> opt_params)

Constructs a sidewiki author 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: description, name, numEntries, rating, resourceId, thumbnail, and uri.

getDescription

google.gdata.sidewiki.SidewikiUserDescription|undefined getDescription()

Returns the Sidewiki author description. This element is optional.

Returns:
Sidewiki author description or undefined for none.

getNumEntries

google.gdata.sidewiki.EntriesNumber|undefined getNumEntries()

Returns the entries number. This element is optional.

Returns:
Entries number or undefined for none.

getRating

google.gdata.Rating|undefined getRating()

Returns the user rating given by the user issued the request. This element is optional.

Returns:
User rating given by the user issued the request or undefined for none.

getResourceId

google.gdata.ResourceId|undefined getResourceId()

Returns the Sidewiki author id. This element is required.

Returns:
Sidewiki author id or undefined for none.

getThumbnail

google.gdata.sidewiki.SidewikiThumbnail|undefined getThumbnail()

Returns the user portrait thumbnail url. This element is optional.

Returns:
User portrait thumbnail url or undefined for none.

setDescription

void setDescription(<google.gdata.sidewiki.SidewikiUserDescription|Object|undefined> description)

Sets the Sidewiki author description. This element is optional.

Parameters:
description - Sidewiki author description, or object to use as a parameter to the google.gdata.sidewiki.SidewikiUserDescription constructor, or undefined for none.

setNumEntries

void setNumEntries(<google.gdata.sidewiki.EntriesNumber|Object|undefined> numEntries)

Sets the entries number. This element is optional.

Parameters:
numEntries - Entries number, or object to use as a parameter to the google.gdata.sidewiki.EntriesNumber constructor, or undefined for none.

setRating

void setRating(<google.gdata.Rating|Object|undefined> rating)

Sets the user rating given by the user issued the request. This element is optional.

Parameters:
rating - User rating given by the user issued the request, or object to use as a parameter to the google.gdata.Rating constructor, or undefined for none.

setResourceId

void setResourceId(<google.gdata.ResourceId|Object|undefined> resourceId)

Sets the Sidewiki author id. This element is required.

Parameters:
resourceId - Sidewiki author id, or object to use as a parameter to the google.gdata.ResourceId constructor, or undefined for none.

setThumbnail

void setThumbnail(<google.gdata.sidewiki.SidewikiThumbnail|Object|undefined> thumbnail)

Sets the user portrait thumbnail url. This element is optional.

Parameters:
thumbnail - User portrait thumbnail url, or object to use as a parameter to the google.gdata.sidewiki.SidewikiThumbnail constructor, or undefined for none.