JGoogleDataPlusPeople

class JGoogleDataPlusPeople extends JGoogleData

Google+ data class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGoogleAuth $auth = null)

Constructor.

boolean
authenticate()

Method to authenticate to Google

from JGoogleData
boolean
isAuthenticated()

Check authentication

from JGoogleData
mixed
getOption( string $key)

Get an option from the JGoogleData instance.

from JGoogleData
JGoogleData
setOption( string $key, mixed $value)

Set an option for the JGoogleData instance.

from JGoogleData
mixed
getPeople( string $id, string $fields = null)

Get a person's profile.

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

Search all public profiles.

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

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

Details

__construct( Registry $options = null, JGoogleAuth $auth = null)

Constructor.

Parameters

Registry $options Google options object.
JGoogleAuth $auth Google data http client object.

boolean authenticate()

Method to authenticate to Google

Return Value

boolean True on success.

boolean isAuthenticated()

Check authentication

Return Value

boolean True if authenticated.

mixed getOption( string $key)

Get an option from the JGoogleData instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JGoogleData setOption( string $key, mixed $value)

Set an option for the JGoogleData instance.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JGoogleData This object for method chaining.

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

Get a person's profile.

Parameters

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.

Return Value

mixed Data from Google

Search all public profiles.

Parameters

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.

Return Value

mixed Data from Google

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

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

Parameters

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.

Return Value

mixed Data from Google