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

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

Inheritance diagram for Google_Service_Blogger_Comments_Resource:
Google_Service_Resource

Public Member Functions

 approve ($blogId, $postId, $commentId, $optParams=array())
 Marks a comment as not spam.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($blogId, $postId, $commentId, $optParams=array())
 Delete a comment by ID.
 
 get ($blogId, $postId, $commentId, $optParams=array())
 Gets one comment by ID.
 
 listByBlog ($blogId, $optParams=array())
 Retrieves the comments for a blog, across all posts, possibly filtered.
 
 listComments ($blogId, $postId, $optParams=array())
 Retrieves the comments for a post, possibly filtered.
 
 markAsSpam ($blogId, $postId, $commentId, $optParams=array())
 Marks a comment as spam.
 
 removeContent ($blogId, $postId, $commentId, $optParams=array())
 Removes the content of a comment.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "comments" collection of methods.

Typical usage is: $bloggerService = new Google_Service_Blogger(...); $comments = $bloggerService->comments;

Member Function Documentation

◆ approve()

Google_Service_Blogger_Comments_Resource::approve ( $blogId,
$postId,
$commentId,
$optParams = array() )

Marks a comment as not spam.

(comments.approve)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
string$commentIdThe ID of the comment to mark as not spam.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Comment

◆ 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

◆ delete()

Google_Service_Blogger_Comments_Resource::delete ( $blogId,
$postId,
$commentId,
$optParams = array() )

Delete a comment by ID.

(comments.delete)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
string$commentIdThe ID of the comment to delete.
array$optParamsOptional parameters.

◆ get()

Google_Service_Blogger_Comments_Resource::get ( $blogId,
$postId,
$commentId,
$optParams = array() )

Gets one comment by ID.

(comments.get)

Parameters
string$blogIdID of the blog to containing the comment.
string$postIdID of the post to fetch posts from.
string$commentIdThe ID of the comment to get.
array$optParamsOptional parameters.

@opt_param string view Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.

Return values
Google_Service_Blogger_Comment

◆ listByBlog()

Google_Service_Blogger_Comments_Resource::listByBlog ( $blogId,
$optParams = array() )

Retrieves the comments for a blog, across all posts, possibly filtered.

(comments.listByBlog)

Parameters
string$blogIdID of the blog to fetch comments from.
array$optParamsOptional parameters.

@opt_param string status @opt_param string startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. @opt_param string endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. @opt_param string maxResults Maximum number of comments to include in the result. @opt_param string pageToken Continuation token if request is paged. @opt_param bool fetchBodies Whether the body content of the comments is included.

Return values
Google_Service_Blogger_CommentList

◆ listComments()

Google_Service_Blogger_Comments_Resource::listComments ( $blogId,
$postId,
$optParams = array() )

Retrieves the comments for a post, possibly filtered.

(comments.listComments)

Parameters
string$blogIdID of the blog to fetch comments from.
string$postIdID of the post to fetch posts from.
array$optParamsOptional parameters.

@opt_param string status @opt_param string startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. @opt_param string endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. @opt_param string maxResults Maximum number of comments to include in the result. @opt_param string pageToken Continuation token if request is paged. @opt_param bool fetchBodies Whether the body content of the comments is included. @opt_param string view Access level with which to view the returned result. Note that some fields require elevated access.

Return values
Google_Service_Blogger_CommentList

◆ markAsSpam()

Google_Service_Blogger_Comments_Resource::markAsSpam ( $blogId,
$postId,
$commentId,
$optParams = array() )

Marks a comment as spam.

(comments.markAsSpam)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
string$commentIdThe ID of the comment to mark as spam.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Comment

◆ removeContent()

Google_Service_Blogger_Comments_Resource::removeContent ( $blogId,
$postId,
$commentId,
$optParams = array() )

Removes the content of a comment.

(comments.removeContent)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
string$commentIdThe ID of the comment to delete content from.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Comment

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