NeedsExamples
opensocial.Name
Base interface for all name objects.
Methods
opensocial.Name.getField
;String getField(key, opt_params)
Parameters
NameTypeDescription |
key |
String |
The key to get data for; keys are defined in Name.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 name that is associated with the specified key.
opensocial.Name.Field
All of the fields that a name has. These are the supported keys for the Name.getField() method.
opensocial.Name.Field.ADDITIONAL_NAME
The additional name, specified as a string. This field may be used interchangeably with the string 'additionalName'.
opensocial.Name.Field.FAMILY_NAME
The family name, specified as a string. This field may be used interchangeably with the string 'familyName'.
opensocial.Name.Field.GIVEN_NAME
The given name, specified as a string. This field may be used interchangeably with the string 'givenName'.
opensocial.Name.Field.HONORIFIC_PREFIX
The honorific prefix, specified as a string. This field may be used interchangeably with the string 'honorificPrefix'.
opensocial.Name.Field.HONORIFIC_SUFFIX
The honorific suffix, specified as a string. This field may be used interchangeably with the string 'honorificSuffix'.
opensocial.Name.Field.UNSTRUCTURED
The unstructured name, specified as a string. This field may be used interchangeably with the string 'unstructured'.
{{ JsApiAlphaList_(v0.9) }}