Opensocial.Name (v0.9)

From VZ Developer Wiki
Jump to: navigation, search

This documentation is not completed yet and will be extended by more examples in future.

opensocial.Name

Base interface for all name objects.

Methods

opensocial.Name.getField

String getField(key, opt_params)
Parameters
Name Type Description
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
Type Description
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'.



OpenSocial (v0.9)

gadgets

gadgets.io

gadgets.json

gadgets.Prefs

gadgets.util

gadgets.views

gadgets.flash

gadgets.MiniMessage

gadgets.oauth.Popup

gadgets.rpc

gadgets.skins

gadgets.pubsub

gadgets.Tab

gadgets.TabSet

gadgets.window

gadgets.i18n

opensocial

opensocial.Activity

opensocial.Address

opensocial.Album

opensocial.BodyType

opensocial.Collection

opensocial.CreateActivityPriority

opensocial.DataRequest

opensocial.DataResponse

opensocial.Email

opensocial.Enum

opensocial.Environment

opensocial.EscapeType

opensocial.IdSpec

opensocial.MediaItem

opensocial.Message

opensocial.MessageCollection

opensocial.Name

opensocial.NavigationParameters

opensocial.Organization

opensocial.Permission

opensocial.Person

opensocial.Phone

opensocial.ResponseItem

opensocial.Url

osapi.Request

osapi.BatchRequest

osapi.people

osapi.activities

osapi.appdata

osapi.messages

osapi.http