Google_Service_Blogger_Comments_Resource Class Reference

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

Inheritance diagram for Google_Service_Blogger_Comments_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	$blogId	The ID of the Blog.
string	$postId	The ID of the Post.
string	$commentId	The ID of the comment to mark as not spam.
array	$optParams	Optional 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	$blogId	The ID of the Blog.
string	$postId	The ID of the Post.
string	$commentId	The ID of the comment to delete.
array	$optParams	Optional parameters.

get()

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

Gets one comment by ID.

(comments.get)

Parameters

string	$blogId	ID of the blog to containing the comment.
string	$postId	ID of the post to fetch posts from.
string	$commentId	The ID of the comment to get.
array	$optParams	Optional 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	$blogId	ID of the blog to fetch comments from.
array	$optParams	Optional 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	$blogId	ID of the blog to fetch comments from.
string	$postId	ID of the post to fetch posts from.
array	$optParams	Optional 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	$blogId	The ID of the Blog.
string	$postId	The ID of the Post.
string	$commentId	The ID of the comment to mark as spam.
array	$optParams	Optional 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	$blogId	The ID of the Blog.
string	$postId	The ID of the Post.
string	$commentId	The ID of the comment to delete content from.
array	$optParams	Optional parameters.

Return values

Google_Service_Blogger_Comment

---

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

• lib/google/src/Google/Service/Blogger.php