Documentation

Comments extends Resource
in package

The "comments" collection of methods.

Typical usage is: $driveService = new Google\Service\Drive(...); $comments = $driveService->comments;

Table of Contents

Properties

$client  : Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed

Methods

__construct()  : mixed
call()  : mixed
TODO: This function needs simplifying.
create()  : Comment
Creates a new comment on a file. (comments.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a comment. (comments.delete)
get()  : Comment
Gets a comment by ID. (comments.get)
listComments()  : CommentList
Lists a file's comments. (comments.listComments)
update()  : Comment
Updates a comment with patch semantics. (comments.update)
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

call()

TODO: This function needs simplifying.

public call(mixed $name, mixed $arguments[, mixed $expectedClass = null ]) : mixed
Parameters
$name : mixed
$arguments : mixed
$expectedClass : mixed = null
  • optional, the expected class name
Tags
@return

Request|$expectedClass

throws
Exception

create()

Creates a new comment on a file. (comments.create)

public create(string $fileId, Comment $postBody[, array<string|int, mixed> $optParams = [] ]) : Comment
Parameters
$fileId : string

The ID of the file.

$postBody : Comment
$optParams : array<string|int, mixed> = []

Optional parameters.

Return values
Comment

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. (comments.delete)

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

The ID of the file.

$commentId : string

The ID of the comment.

$optParams : array<string|int, mixed> = []

Optional parameters.

get()

Gets a comment by ID. (comments.get)

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

The ID of the file.

$commentId : string

The ID of the comment.

$optParams : array<string|int, mixed> = []

Optional parameters.

Tags
opt_param

bool includeDeleted Whether to return deleted comments. Deleted comments will not include their original content.

Return values
Comment

listComments()

Lists a file's comments. (comments.listComments)

public listComments(string $fileId[, array<string|int, mixed> $optParams = [] ]) : CommentList
Parameters
$fileId : string

The ID of the file.

$optParams : array<string|int, mixed> = []

Optional parameters.

Tags
opt_param

bool includeDeleted Whether to include deleted comments. Deleted comments will not include their original content.

opt_param

int pageSize The maximum number of comments to return per page.

opt_param

string pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

opt_param

string startModifiedTime The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).

Return values
CommentList

update()

Updates a comment with patch semantics. (comments.update)

public update(string $fileId, string $commentId, Comment $postBody[, array<string|int, mixed> $optParams = [] ]) : Comment
Parameters
$fileId : string

The ID of the file.

$commentId : string

The ID of the comment.

$postBody : Comment
$optParams : array<string|int, mixed> = []

Optional parameters.

Return values
Comment

convertToArrayAndStripNulls()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results