Opensocial.Address (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.Address

Base interface for all address objects.

Methods

opensocial.Address.getField

String getField(key, opt_params)
Parameters
Name Type Description
key String The key to get data for; keys are defined in Address.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 body type that is associated with the specified key.

opensocial.Address.Field

All of the fields that an address has. These are the supported keys for the Address.getField() method.

opensocial.Address.Field.COUNTRY

The country, specified as a string. This field may be used interchangeably with the string 'country'.

opensocial.Address.Field.LOCALITY

The locality, specified as a string. This field may be used interchangeably with the string 'locality'.

opensocial.Address.Field.POSTAL_CODE

The postal code, specified as a string. This field may be used interchangeably with the string 'postalCode'.

opensocial.Address.Field.STREET_ADDRESS

The street address, specified as a string. This field may be used interchangeably with the string 'streetAddress'.



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