Class opensocial.Person
Base interface for all person objects.
Defined in: opensocial.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
|
Gets a text display name for this person; guaranteed to return
a useful string.
|
|
|
getField(key, opt_params)
Gets data for this person that is associated with the specified key.
|
|
|
getId()
Gets an ID that can be permanently associated with this person.
|
|
|
isOwner()
Returns true if this person object represents the owner of the current page.
|
|
|
isViewer()
Returns true if this person object represents the currently logged in user.
|
Method Detail
{String}
getDisplayName()
Gets a text display name for this person; guaranteed to return
a useful string.
- Returns:
- {String} The display name
{String}
getField(key, opt_params)
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 - {Map.<opensocial.DataRequest.DataRequestFields|Object>} opt_params
- Additional params to pass to the request.
- Returns:
- {String} The data
{String}
getId()
Gets an ID that can be permanently associated with this person.
- Returns:
- {String} The ID
{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
{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