Opensocial.Url (v0.9)

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

opensocial.Url

Base interface for all URL objects.

Methods

opensocial.Url.getField

String getField(key, opt_params)

Parameters

Name	Type	Description
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

Type	Description
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'.

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