Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_Plus_Activities_Resource Class Reference

The "activities" collection of methods. More...

Inheritance diagram for Google_Service_Plus_Activities_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($activityId, $optParams=array())
 Get an activity.
 
 listActivities ($userId, $collection, $optParams=array())
 List all of the activities in the specified collection for a particular user.
 
 search ($query, $optParams=array())
 Search public activities.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "activities" collection of methods.

Typical usage is: $plusService = new Google_Service_Plus(...); $activities = $plusService->activities;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ get()

Google_Service_Plus_Activities_Resource::get ( $activityId,
$optParams = array() )

Get an activity.

(activities.get)

Parameters
string$activityIdThe ID of the activity to get.
array$optParamsOptional parameters.
Return values
Google_Service_Plus_Activity

◆ listActivities()

Google_Service_Plus_Activities_Resource::listActivities ( $userId,
$collection,
$optParams = array() )

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

(activities.listActivities)

Parameters
string$userIdThe ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.
string$collectionThe collection of activities to list.
array$optParamsOptional parameters.

@opt_param string pageToken The continuation token, which is 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. @opt_param string maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Return values
Google_Service_Plus_ActivityFeed

◆ search()

Google_Service_Plus_Activities_Resource::search ( $query,
$optParams = array() )

Search public activities.

(activities.search)

Parameters
string$queryFull-text search query string.
array$optParamsOptional parameters.

@opt_param string orderBy Specifies how to order search results. @opt_param string pageToken The continuation token, which is 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 can be of any length. @opt_param string maxResults The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. @opt_param string language Specify the preferred language to search with. See search language codes for available values.

Return values
Google_Service_Plus_ActivityFeed

The documentation for this class was generated from the following file: