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

The "comments" collection of methods. More...

Inheritance diagram for Google_Service_Plus_Comments_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($commentId, $optParams=array())
 Get a comment.
 
 listComments ($activityId, $optParams=array())
 List all of the comments for an activity.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "comments" collection of methods.

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

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_Comments_Resource::get ( $commentId,
$optParams = array() )

Get a comment.

(comments.get)

Parameters
string$commentIdThe ID of the comment to get.
array$optParamsOptional parameters.
Return values
Google_Service_Plus_Comment

◆ listComments()

Google_Service_Plus_Comments_Resource::listComments ( $activityId,
$optParams = array() )

List all of the comments for an activity.

(comments.listComments)

Parameters
string$activityIdThe ID of the activity to get comments for.
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 sortOrder The order in which to sort the list of comments. @opt_param string maxResults The maximum number of comments 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_CommentFeed

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