Docs For Class JGoogleDataPlusActivities

Description

Google+ data class for the Joomla Platform.

since: 1234

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

JGoogleData
   |
   --JGoogleDataPlusActivities

Method Summary

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

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

mixed listActivities (string $userId, string $collection, [string $fields = null], [integer $max = 10], [string $token = null], [string $alt = null])

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

Variables

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
JGoogleData::$options

Methods

Constructor __construct (line 29)

Constructor.

since: 1234
access: public

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

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

Redefinition of:

JGoogleData::__construct(): Constructor.

getActivity (line 108)

Get an activity.

return: Data from Google
since: 1234
access: public

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

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)

listActivities (line 54)

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

return: Data from Google
since: 1234
access: public

mixed listActivities (string $userId, string $collection, [string $fields = null], [integer $max = 10], [string $token = null], [string $alt = null])

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)

search (line 152)

Search all public activities.

return: Data from Google
since: 1234
access: public

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

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.

Inherited Methods

Inherited From JGoogleData

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