Documentation

Google_Service_Blogger_Resource_Comments extends Google_Service_Resource
in package

The "comments" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
approve()  : Google_Service_Blogger_Comment
Marks a comment as not spam by blog id, post id and comment id.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a comment by blog id, post id and comment id. (comments.delete)
get()  : Google_Service_Blogger_Comment
Gets a comment by id. (comments.get)
listByBlog()  : Google_Service_Blogger_CommentList
Lists comments by blog. (comments.listByBlog)
listComments()  : Google_Service_Blogger_CommentList
Lists comments. (comments.listComments)
markAsSpam()  : Google_Service_Blogger_Comment
Marks a comment as spam by blog id, post id and comment id.
removeContent()  : Google_Service_Blogger_Comment
Removes the content of a comment by blog id, post id and comment id.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

approve()

Marks a comment as not spam by blog id, post id and comment id.

public approve(string $blogId, string $postId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_Comment

(comments.approve)

Parameters
$blogId : string
$postId : string
$commentId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Blogger_Comment

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a comment by blog id, post id and comment id. (comments.delete)

public delete(string $blogId, string $postId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$blogId : string
$postId : string
$commentId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Gets a comment by id. (comments.get)

public get(string $blogId, string $postId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_Comment
Parameters
$blogId : string
$postId : string
$commentId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string view

Return values
Google_Service_Blogger_Comment

listByBlog()

Lists comments by blog. (comments.listByBlog)

public listByBlog(string $blogId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_CommentList
Parameters
$blogId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string status

opt_param

string endDate

opt_param

string pageToken

opt_param

string maxResults

opt_param

bool fetchBodies

opt_param

string startDate

Return values
Google_Service_Blogger_CommentList

listComments()

Lists comments. (comments.listComments)

public listComments(string $blogId, string $postId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_CommentList
Parameters
$blogId : string
$postId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken

opt_param

string maxResults

opt_param

string startDate

opt_param

string endDate

opt_param

bool fetchBodies

opt_param

string status

opt_param

string view

Return values
Google_Service_Blogger_CommentList

markAsSpam()

Marks a comment as spam by blog id, post id and comment id.

public markAsSpam(string $blogId, string $postId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_Comment

(comments.markAsSpam)

Parameters
$blogId : string
$postId : string
$commentId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Blogger_Comment

removeContent()

Removes the content of a comment by blog id, post id and comment id.

public removeContent(string $blogId, string $postId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Blogger_Comment

(comments.removeContent)

Parameters
$blogId : string
$postId : string
$commentId : string
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Blogger_Comment

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results