Docs For Class JGoogleDataPlusComments

Description

Google+ data class for the Joomla Platform.

since: 1234

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

JGoogleData
   |
   --JGoogleDataPlusComments

Method Summary

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

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

mixed listComments (string $activityId, [string $fields = null], [integer $max = 20], [string $order = null], [string $token = null], [string $alt = null])

Variables

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
JGoogleData::$options

Methods

Constructor __construct (line 29)

Constructor.

since: 1234
access: public

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

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

Redefinition of:

JGoogleData::__construct(): Constructor.

getComment (line 114)

Get a comment.

return: Data from Google
since: 1234
access: public

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

string $id: The ID of the comment to get.
string $fields: Used to specify the fields you want returned.

listComments (line 54)

List all of the comments for an activity.

return: Data from Google
since: 1234
access: public

mixed listComments (string $activityId, [string $fields = null], [integer $max = 20], [string $order = null], [string $token = null], [string $alt = null])

string $activityId: The ID of the activity to get comments for.
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 $order: The order in which to sort the list of comments. Acceptable values are "ascending" and "descending".
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)

Inherited Methods

Inherited From JGoogleData

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