com.google.gwt.gadgets.client.osapi.people
Class Person

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.google.gwt.gadgets.client.osapi.people.Person

public class Person
extends com.google.gwt.core.client.JavaScriptObject

A class that represents a person and defines a minimal set of fields that opensocial container is required to implement. This class is meant to be extended to be used with specific containers.

Field Summary

static java.lang.String	DISPLAY_NAME Field identifier for person's name suitable for display.
static java.lang.String	ID Field identifier for person's string ID.
static java.lang.String	THUMBNAIL_URL Field identifier for person's photo thumbnail URL.

Constructor Summary

protected

Person() Required by JavaScriptObject policy.

Method Summary

java.lang.String	getDisplayName() Returns the name of this Person, suitable for display to end-users.
java.lang.String	getId() Returns a string Id that can be permanently associated with this person.
java.lang.String	getThumbnailUrl() Returns person's photo thumbnail URL, specified as a string.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

Field identifier for person's name suitable for display.

See Also:

Constant Field Values

ID

public static final java.lang.String ID

Field identifier for person's string ID.

See Also:

Constant Field Values

THUMBNAIL_URL

public static final java.lang.String THUMBNAIL_URL

Field identifier for person's photo thumbnail URL.

See Also:

Constant Field Values

Constructor Detail

Person

protected Person()

Required by JavaScriptObject policy.

Method Detail

getDisplayName

public final java.lang.String getDisplayName()

Returns the name of this Person, suitable for display to end-users.

Returns:

The name of this Person, suitable for display to end-users.

getId

public final java.lang.String getId()

Returns a string Id that can be permanently associated with this person. For the anonymous viewer, this value is -1.

Returns:

A string Id that can be permanently associated with this person.

getThumbnailUrl

public final java.lang.String getThumbnailUrl()

Returns person's photo thumbnail URL, specified as a string. Returned URL is fully qualified.

Returns:

Person's photo thumbnail URL, specified as a string.