Opensocial.Environment (v0.9)

From VZ Developer Wiki
Revision as of 12:15, 29 July 2010 by Seba (talk | contribs) (Created page with '{{NeedsExamples}} <div style="float:right; margin: 0 0 10px 10px;">__TOC__</div> <span style="font-size:150%"><strong>opensocial.Environment</strong></span> Represents the curr…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

opensocial.Environment

Represents the current environment for a gadget. See also: opensocial.getEnvironment(),

Methods

opensocial.Environment.getDomain

String getDomain()
Returns
Type Description
String The domain
Description
Returns the current domain. for example, "orkut.com" or "myspace.com".

opensocial.Environment.supportsField

Boolean supportsField(objectType, fieldName)
Parameters
Name Type Description
objectType opensocial.Environment.ObjectType The object type to check for the field
fieldName String The name of the field to check for
Returns
Type Description
Boolean True if the field is supported on the specified object type
Description
Returns true if the specified field is supported in this container on the given object type, and returns false otherwise.

opensocial.Environment.ObjectType

The types of objects in this container. See also: Environment.supportsField()

opensocial.Environment.ObjectType.ACTIVITY

<static> Member of: opensocial.Environment.ObjectType.ACTIVITY This field may be used interchangeably with the string 'activity'.

opensocial.Environment.ObjectType.ADDRESS

<static> Member of: opensocial.Environment.ObjectType.ADDRESS This field may be used interchangeably with the string 'address'.

opensocial.Environment.ObjectType.BODY_TYPE

<static> Member of: opensocial.Environment.ObjectType.BODY_TYPE This field may be used interchangeably with the string 'bodyType'.

opensocial.Environment.ObjectType.EMAIL

This field may be used interchangeably with the string 'email'.

opensocial.Environment.ObjectType.FILTER_TYPE

<static> Member of: opensocial.Environment.ObjectType.FILTER_TYPE This field may be used interchangeably with the string 'filterType'.

opensocial.Environment.ObjectType.MEDIA_ITEM

<static> Member of: opensocial.Environment.ObjectType.MEDIA_ITEM This field may be used interchangeably with the string 'mediaItem'.

opensocial.Environment.ObjectType.MESSAGE

<static> Member of: opensocial.Environment.ObjectType.MESSAGE This field may be used interchangeably with the string 'message'.

opensocial.Environment.ObjectType.MESSAGE_TYPE

<static> Member of: opensocial.Environment.ObjectType.MESSAGE_TYPE This field may be used interchangeably with the string 'messageType'.

opensocial.Environment.ObjectType.NAME

This field may be used interchangeably with the string 'name'.

opensocial.Environment.ObjectType.ORGANIZATION

<static> Member of: opensocial.Environment.ObjectType.ORGANIZATION This field may be used interchangeably with the string 'organization'.

opensocial.Environment.ObjectType.PERSON

<static> Member of: opensocial.Environment.ObjectType.PERSON This field may be used interchangeably with the string 'person'.

opensocial.Environment.ObjectType.PHONE

This field may be used interchangeably with the string 'phone'.

opensocial.Environment.ObjectType.SORT_ORDER

<static> Member of: opensocial.Environment.ObjectType.SORT_ORDER This field may be used interchangeably with the string 'sortOrder'.

opensocial.Environment.ObjectType.URL

This field may be used interchangeably with the string 'url'.



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