JGoogleDataPlusActivities
Extends \JGoogleDataGoogle+ data class for the Joomla Platform.
| since |
3.1.4 |
|---|---|
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null)
| since |
3.1.4 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGoogle options object.- $auth
\JGoogleAuthGoogle data http client object.
authenticate
Method to authenticate to Google
authenticate() : boolean
| since |
3.1.4 |
|---|
Response
booleanTrue on success.
getActivity
Get an activity.
getActivity(string $id, string $fields = null, string $alt = null) : mixed
| since |
3.1.4 |
|---|
Arguments
- $id
stringThe ID of the activity to get.- $fields
stringUsed to specify the fields you want returned.- $alt
stringSpecifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)
Response
mixedData from Google
getOption
Get an option from the JGoogleData instance.
getOption(string $key) : mixed
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe option value.
isAuthenticated
Check authentication
isAuthenticated() : boolean
| since |
3.1.4 |
|---|
Response
booleanTrue if authenticated.
listActivities
List all of the activities in the specified collection for a particular user.
listActivities(string $userId, string $collection, string $fields = null, integer $max = 10, string $token = null, string $alt = null) : mixed
| since |
3.1.4 |
|---|
Arguments
- $userId
stringThe ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.- $collection
stringThe collection of activities to list. Acceptable values are: "public".- $fields
stringUsed to specify the fields you want returned.- $max
integerThe maximum number of people to include in the response, used for paging.- $token
stringThe 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.- $alt
stringSpecifies an alternative representation type. Acceptable values are: "json" - Use JSON format (default)
Response
mixedData from Google
listGetData
Method to retrieve a list of data
listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
| since |
3.1.4 |
|---|---|
| throws |
|
Arguments
- $url
arrayURL to GET- $maxpages
integerMaximum number of pages to return- $token
stringNext page token
Response
mixedData from Google
query
Method to retrieve data from Google
query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
| since |
3.1.4 |
|---|
Arguments
- $url
stringThe URL for the request.- $data
mixedThe data to include in the request.- $headers
arrayThe headers to send with the request.- $method
stringThe type of http request to send.
Response
mixedData from Google.
safeXml
Method to validate XML
safeXml(string $data) : \SimpleXMLElement
| since |
3.1.4 |
|---|---|
| throws |
|
Arguments
- $data
stringXML data to be parsed
Response
\SimpleXMLElementXMLElement of parsed data
search
Search all public activities.
search(string $query, string $fields = null, string $language = null, integer $max = 10, string $order = null, string $token = null) : mixed
| since |
3.1.4 |
|---|
Arguments
- $query
stringFull-text search query string.- $fields
stringUsed to specify the fields you want returned.- $language
stringSpecify the preferred language to search with. https://developers.google.com/+/api/search#available-languages- $max
integerThe maximum number of people to include in the response, used for paging.- $order
stringSpecifies how to order search results. Acceptable values are "best" and "recent".- $token
stringThe 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.
Response
mixedData from Google
setOption
Set an option for the JGoogleData instance.
setOption(string $key, mixed $value) : \JGoogleData
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JGoogleDataThis object for method chaining.