Google_Service_Drive_Comments_Resource Class Reference

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

Inheritance diagram for Google_Service_Drive_Comments_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($fileId, $commentId, $optParams=array())
	Deletes a comment.
	get ($fileId, $commentId, $optParams=array())
	Gets a comment by ID.
	insert ($fileId, Google_Service_Drive_Comment $postBody, $optParams=array())
	Creates a new comment on the given file.
	listComments ($fileId, $optParams=array())
	Lists a file's comments.
	patch ($fileId, $commentId, Google_Service_Drive_Comment $postBody, $optParams=array())
	Updates an existing comment.
	update ($fileId, $commentId, Google_Service_Drive_Comment $postBody, $optParams=array())
	Updates an existing comment.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "comments" collection of methods.

Typical usage is: $driveService = new Google_Service_Drive(...); $comments = $driveService->comments;

Member Function Documentation

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_Drive_Comments_Resource::delete	(		$fileId,
			$commentId,
			$optParams = array() )

Deletes a comment.

(comments.delete)

Parameters

string	$fileId	The ID of the file.
string	$commentId	The ID of the comment.
array	$optParams	Optional parameters.

get()

Google_Service_Drive_Comments_Resource::get	(		$fileId,
			$commentId,
			$optParams = array() )

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.

@opt_param bool includeDeleted If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.

Return values

Google_Service_Drive_Comment

insert()

Google_Service_Drive_Comments_Resource::insert	(		$fileId,
		Google_Service_Drive_Comment	$postBody,
			$optParams = array() )

Creates a new comment on the given file.

(comments.insert)

Parameters

string	$fileId	The ID of the file.
Google_Comment	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_Comment

listComments()

Google_Service_Drive_Comments_Resource::listComments	(		$fileId,
			$optParams = array() )

Lists a file's comments.

(comments.listComments)

Parameters

string	$fileId	The ID of the file.
array	$optParams	Optional parameters.

@opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. @opt_param string updatedMin Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp. @opt_param bool includeDeleted If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned. @opt_param int maxResults The maximum number of discussions to include in the response, used for paging.

Return values

Google_Service_Drive_CommentList

patch()

Google_Service_Drive_Comments_Resource::patch	(		$fileId,
			$commentId,
		Google_Service_Drive_Comment	$postBody,
			$optParams = array() )

Updates an existing comment.

This method supports patch semantics. (comments.patch)

Parameters

string	$fileId	The ID of the file.
string	$commentId	The ID of the comment.
Google_Comment	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_Comment

update()

Google_Service_Drive_Comments_Resource::update	(		$fileId,
			$commentId,
		Google_Service_Drive_Comment	$postBody,
			$optParams = array() )

Updates an existing comment.

(comments.update)

Parameters

string	$fileId	The ID of the file.
string	$commentId	The ID of the comment.
Google_Comment	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_Comment

---

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

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