English | Site Directory

opensocial.Environment (v0.7)

 SUMMARY     DETAIL

Class opensocial.Environment

Represents the current environment for a gadget.

See also: opensocial.getEnvironment(),

Method Summary

 String getDomain()
Returns the current domain — for example, "orkut.com" or "myspace.com".
 Boolean supportsField(objectType, fieldName)
Returns true if the specified field is supported in this container on the given object type.
 

Method Detail

getDomain

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

supportsField

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 1.3.3