JGoogleDataPlusComments

class JGoogleDataPlusComments 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
listComments( string $activityId, string $fields = null, integer $max = 20, string $order = null, string $token = null, string $alt = null)

List all of the comments for an activity.

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

Get a comment.

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 listComments( string $activityId, string $fields = null, integer $max = 20, string $order = null, string $token = null, string $alt = null)

List all of the comments for an activity.

Parameters

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)

Return Value

mixed Data from Google

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

Get a comment.

Parameters

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

Return Value

mixed Data from Google