opensocial.Person (v0.7)

 SUMMARY     DETAIL

Class opensocial.Person

Base interface for all person objects.

Method Summary

 String getDisplayName()

Gets a text display name for this person; guaranteed to return a useful string.

 String getField(key)

Gets data for this person that is associated with the specified key.

 String getId()

Gets an ID that can be permanently associated with this person.

 Boolean isOwner()

Returns true if this person object represents the owner of the current page.

 Boolean isViewer()

Returns true if this person object represents the currently logged in user.

 

Method Detail

getDisplayName

String getDisplayName()

Gets a text display name for this person; guaranteed to return a useful string.

Returns:
String The display name

getField

String getField(key)

Gets data for this person that is associated with the specified key.

Parameters:
String key - The key to get data for; keys are defined in Person.Field

Returns:
String The data

getId

String getId()

Gets an ID that can be permanently associated with this person.

Returns:
String The ID

isOwner

Boolean isOwner()

Returns true if this person object represents the owner of the current page.

Returns:
Boolean True if this is the owner of the page; otherwise, false

isViewer

Boolean isViewer()

Returns true if this person object represents the currently logged in user.

Returns:
Boolean True if this is the currently logged in user; otherwise, false

---