Opensocial.BodyType (v0.9)

NeedsExamples

opensocial.BodyType

Base interface for all body type objects.

Methods

opensocial.BodyType.getField

;String getField(key, opt_params)

Parameters
NameTypeDescription |

key

String

The key to get data for; keys are defined in BodyType.Field

opt_params

Map.<opensocial.DataRequest.DataRequestFields

Object>

Additional params to pass to the request.

Returns
TypeDescription |

String

The data

Description
Gets data for this body type that is associated with the specified key.

opensocial.BodyType.Field

All of the fields that a body type has. These are the supported keys for the BodyType.getField() method.

opensocial.BodyType.Field.BUILD

The build of the person's body, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'build'.

opensocial.BodyType.Field.EYE_COLOR

The eye color of the person, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'eyeColor'.

opensocial.BodyType.Field.HAIR_COLOR

The hair color of the person, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'hairColor'.

opensocial.BodyType.Field.HEIGHT

The height of the person in meters, specified as a number. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'height'.

opensocial.BodyType.Field.WEIGHT

The weight of the person in kilograms, specified as a number. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'weight'.

{{ JsApiAlphaList_(v0.9) }}