Docs For Class JGoogleDataPlusPeople

Description

Google+ data class for the Joomla Platform.

since: 1234

Located in /libraries/joomla/google/data/plus/people.php (line 19)

JGoogleData
   |
   --JGoogleDataPlusPeople

Method Summary

JGoogleDataPlusPeople __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

mixed getPeople (string $id, [string $fields = null])

mixed listByActivity (string $activityId, string $collection, [string $fields = null], [integer $max = 10], [string $token = null])

mixed search (string $query, [string $fields = null], [string $language = null], [integer $max = 10], [string $token = null])

Variables

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
JGoogleData::$options

Methods

Constructor __construct (line 29)

Constructor.

since: 1234
access: public

JGoogleDataPlusPeople __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

JRegistry $options: Google options object
JGoogleAuth $auth: Google data http client object

Redefinition of:

JGoogleData::__construct(): Constructor.

getPeople (line 49)

Get a person's profile.

return: Data from Google
since: 1234
access: public

mixed getPeople (string $id, [string $fields = null])

string $id: The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.
string $fields: Used to specify the fields you want returned.

listByActivity (line 139)

List all of the people in the specified collection for a particular activity.

return: Data from Google
since: 1234
access: public

mixed listByActivity (string $activityId, string $collection, [string $fields = null], [integer $max = 10], [string $token = null])

string $activityId: The ID of the activity to get the list of people for.
string $collection: The collection of people to list. Acceptable values are "plusoners" and "resharers".
string $fields: Used to specify the fields you want returned.
integer $max: The maximum number of people to include in the response, used for paging.
string $token: The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.

search (line 85)

Search all public profiles.

return: Data from Google
since: 1234
access: public

mixed search (string $query, [string $fields = null], [string $language = null], [integer $max = 10], [string $token = null])

string $query: Specify a query string for full text search of public text in all profiles.
string $fields: Used to specify the fields you want returned.
string $language: Specify the preferred language to search with. https://developers.google.com/+/api/search#available-languages
integer $max: The maximum number of people to include in the response, used for paging.
string $token: The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.

Inherited Methods

Inherited From JGoogleData

JGoogleData::__construct()
JGoogleData::authenticate()
JGoogleData::getOption()
JGoogleData::isAuthenticated()
JGoogleData::listGetData()
JGoogleData::query()
JGoogleData::safeXML()
JGoogleData::setOption()