|
GData JavaScript Client 1.5 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.Rating
Describes a rating.
Defined in gdata.js
Field Summary | |
{String|undefined} |
average
Average rating. |
{String|undefined} |
max
Rating scale's maximum value. |
{String|undefined} |
min
Rating scale's minimum value. |
{String|undefined} |
numRaters
Number of ratings taken into account when computing the average value. |
{String|undefined} |
rel
Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. |
{String|undefined} |
value
Rating value. |
<static> <final> String |
REL_OVERALL
Overall rating, higher values mean better ratings. |
<static> <final> String |
REL_PRICE
Price rating, higher values mean better ratings. |
<static> <final> String |
REL_QUALITY
Quality rating, higher values mean better ratings. |
Constructor Summary | |
google.gdata.Rating(<Object> opt_params)
Constructs a rating using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
Number|undefined
|
getAverage()
Returns the average rating. |
Number|undefined
|
getMax()
Returns the rating scale's maximum value. |
Number|undefined
|
getMin()
Returns the rating scale's minimum value. |
Number|undefined
|
getNumRaters()
Returns the number of ratings taken into account when computing the average value. |
String|undefined
|
getRel()
Returns the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. |
Number|undefined
|
getValue()
Returns the rating value. |
void
|
setAverage(<Number|undefined> average)
Sets the average rating. |
void
|
setMax(<Number|undefined> max)
Sets the rating scale's maximum value. |
void
|
setMin(<Number|undefined> min)
Sets the rating scale's minimum value. |
void
|
setNumRaters(<Number|undefined> numRaters)
Sets the number of ratings taken into account when computing the average value. |
void
|
setRel(<String|undefined> rel)
Sets the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. |
void
|
setValue(<Number|undefined> value)
Sets the rating value. |
Field Detail |
{String|undefined} average
{String|undefined} max
{String|undefined} min
{String|undefined} numRaters
{String|undefined} rel
{String|undefined} value
<static> <final> String REL_OVERALL
<static> <final> String REL_PRICE
<static> <final> String REL_QUALITY
Constructor Detail |
google.gdata.Rating(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: average, max, min, numRaters, rel, and value
Method Detail |
Number|undefined getAverage()
Number|undefined getMax()
Number|undefined getMin()
Number|undefined getNumRaters()
String|undefined getRel()
Number|undefined getValue()
void setAverage(<Number|undefined> average)
average
- Average rating or undefined for none
void setMax(<Number|undefined> max)
max
- Rating scale's maximum value or undefined for none
void setMin(<Number|undefined> min)
min
- Rating scale's minimum value or undefined for none
void setNumRaters(<Number|undefined> numRaters)
numRaters
- Number of ratings taken into account when computing the average value or undefined for none
void setRel(<String|undefined> rel)
rel
- Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating or undefined for none
void setValue(<Number|undefined> value)
value
- Rating value or undefined for none
|
GData JavaScript Client 1.5 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |