Opensocial.Url (v0.9)

Owned by Mark Halvorson (Deactivated)
Last updated: Oct 05, 2010Version comment

NeedsExamples

opensocial.Url

Base interface for all URL objects.

Methods

opensocial.Url.getField

;String getField(key, opt_params)

Parameters
NameTypeDescription |

key

String

The key to get data for; keys are defined in Url.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 URL that is associated with the specified key.

opensocial.Url.Field

All of the fields that a URL has. These are the supported keys for the Url.getField() method.

opensocial.Url.Field.ADDRESS

The address the URL points to, specified as a string. This field may be used interchangeably with the string 'address'.

opensocial.Url.Field.LINK_TEXT

The text of the link, specified as a string. This field may be used interchangeably with the string 'linkText'.

opensocial.Url.Field.TYPE

The URL number type or label, specified as a string. Examples: work, blog feed, website, etc. This field may be used interchangeably with the string 'type'.

{{ JsApiAlphaList_(v0.9) }}