Class Index

Classes


Class opensocial.Environment

Represents the current environment for a gadget.

See also: opensocial.getEnvironment(),
Defined in: opensocial.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Returns the current domain — for example, "orkut.com" or "myspace.com".
 
supportsField(objectType, fieldName)
Returns true if the specified field is supported in this container on the given object type.
Class Detail
opensocial.Environment()
Method Detail
{String} getDomain()
Returns the current domain — for example, "orkut.com" or "myspace.com".
Returns:
{String} The domain

{Boolean} supportsField(objectType, fieldName)
Returns true if the specified field is supported in this container on the given object type.
Parameters:
{opensocial.Environment.ObjectType} objectType
The object type to check for the field
{String} fieldName
The name of the field to check for
Returns:
{Boolean} True if the field is supported on the specified object type

Documentation generated by JsDoc Toolkit 2.0.2 on Wed Nov 12 2008 12:32:43 GMT-0800 (PST)