Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Plus_Moments_Resource Class Reference

The "moments" collection of methods. More...

Inheritance diagram for Google_Service_Plus_Moments_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 insert ($userId, $collection, Google_Service_Plus_Moment $postBody, $optParams=array())
 Record a moment representing a user's action such as making a purchase or commenting on a blog.
 
 listMoments ($userId, $collection, $optParams=array())
 List all of the moments for a particular user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "moments" collection of methods.

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

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

◆ insert()

Google_Service_Plus_Moments_Resource::insert ( $userId,
$collection,
Google_Service_Plus_Moment $postBody,
$optParams = array() )

Record a moment representing a user's action such as making a purchase or commenting on a blog.

(moments.insert)

Parameters
string$userIdThe ID of the user to record actions for. The only valid values are "me" and the ID of the authenticated user.
string$collectionThe collection to which to write moments.
Google_Moment$postBody
array$optParamsOptional parameters.

@opt_param bool debug Return the moment as written. Should be used only for debugging.

Return values
Google_Service_Plus_Moment

◆ listMoments()

Google_Service_Plus_Moments_Resource::listMoments ( $userId,
$collection,
$optParams = array() )

List all of the moments for a particular user.

(moments.listMoments)

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

@opt_param string maxResults The maximum number of moments 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 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 targetUrl Only moments containing this targetUrl will be returned. @opt_param string type Only moments of this type will be returned.

Return values
Google_Service_Plus_MomentsFeed

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