1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Drive
  7. \
  8. Resource
  9. \
  10. Comments

Comments

class Comments extends Resource (View source)

The "comments" collection of methods.

Typical usage is:

 $driveService = new Google\Service\Drive(...);
 $comments = $driveService->comments;

Methods

Comment
create(string $fileId, Comment $postBody, array $optParams = [])

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

delete(string $fileId, string $commentId, array $optParams = [])

Deletes a comment. (comments.delete)

Comment
get(string $fileId, string $commentId, array $optParams = [])

Gets a comment by ID. (comments.get)

CommentList
listComments(string $fileId, array $optParams = [])

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

Comment
update(string $fileId, string $commentId, Comment $postBody, array $optParams = [])

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

Details

at line 42
Comment create(string $fileId, Comment $postBody, array $optParams = [])

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

Parameters

string $fileId

The ID of the file.
Comment $postBody
array $optParams

Optional parameters.

Return Value

Comment

Exceptions

Exception

at line 56
delete(string $fileId, string $commentId, array $optParams = [])

Deletes a comment. (comments.delete)

Parameters

string $fileId

The ID of the file.
string $commentId

The ID of the comment.
array $optParams

Optional parameters.

Exceptions

Exception

at line 74
Comment get(string $fileId, string $commentId, array $optParams = [])

Gets a comment by ID. (comments.get)

Parameters

string $fileId

The ID of the file.
string $commentId

The ID of the comment.
array $optParams

Optional parameters.

Return Value

Comment

Exceptions

Exception

at line 97
CommentList listComments(string $fileId, array $optParams = [])

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

Parameters

string $fileId

The ID of the file.
array $optParams

Optional parameters.

Return Value

CommentList

Exceptions

Exception

at line 113
Comment update(string $fileId, string $commentId, Comment $postBody, array $optParams = [])

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

Parameters

string $fileId

The ID of the file.
string $commentId

The ID of the comment.
Comment $postBody
array $optParams

Optional parameters.

Return Value

Comment

Exceptions

Exception