JGoogleDataPlusActivities

class JGoogleDataPlusActivities 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
listActivities( string $userId, string $collection, string $fields = null, integer $max = 10, string $token = null, string $alt = null)

List all of the activities in the specified collection for a particular user.

mixed
getActivity( string $id, string $fields = null, string $alt = null)

Get an activity.

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

Search all public activities.

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 listActivities( string $userId, string $collection, string $fields = null, integer $max = 10, string $token = null, string $alt = null)

List all of the activities in the specified collection for a particular user.

Parameters

string $userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.
string $collection The collection of activities to list. Acceptable values are: "public".
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.
string $alt Specifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)

Return Value

mixed Data from Google

mixed getActivity( string $id, string $fields = null, string $alt = null)

Get an activity.

Parameters

string $id The ID of the activity to get.
string $fields Used to specify the fields you want returned.
string $alt Specifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)

Return Value

mixed Data from Google

Search all public activities.

Parameters

string $query Full-text search query string.
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 $order Specifies how to order search results. Acceptable values are "best" and "recent".
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