NeedsExamples

opensocial.Environment

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

Methods

opensocial.Environment.getDomain

;String getDomain()

Returns
TypeDescription |

Description
Returns the current domain. for example, "orkut.com" or "myspace.com".

opensocial.Environment.supportsField

;Boolean supportsField(objectType, fieldName)

Parameters
NameTypeDescription |

Returns
TypeDescription |

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

{{ JsApiAlphaList_(v0.9) }}