Viewing file:  Comments.php (4.1 KB) -rwxrwxrwx
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "comments" collection of methods.
* Typical usage is:
* <code>
* $driveService = new Google_Service_Drive(...);
* $comments = $driveService->comments;
* </code>
*/
class Google_Service_Drive_Resource_Comments extends Google_Service_Resource
{
/**
* Creates a new comment on a file. (comments.create)
*
* @param string $fileId The ID of the file.
* @param Google_Service_Drive_Comment $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Drive_Comment
*/
public function create($fileId, Google_Service_Drive_Comment $postBody, $optParams = array())
{
$params = array('fileId' => $fileId, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('create', array($params), "Google_Service_Drive_Comment");
}
/**
* Deletes a comment. (comments.delete)
*
* @param string $fileId The ID of the file.
* @param string $commentId The ID of the comment.
* @param array $optParams Optional parameters.
*/
public function delete($fileId, $commentId, $optParams = array())
{
$params = array('fileId' => $fileId, 'commentId' => $commentId);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params));
}
/**
* Gets a comment by ID. (comments.get)
*
* @param string $fileId The ID of the file.
* @param string $commentId The ID of the comment.
* @param array $optParams Optional parameters.
*
* @opt_param bool includeDeleted Whether to return deleted comments. Deleted
* comments will not include their original content.
* @return Google_Service_Drive_Comment
*/
public function get($fileId, $commentId, $optParams = array())
{
$params = array('fileId' => $fileId, 'commentId' => $commentId);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Drive_Comment");
}
/**
* Lists a file's comments. (comments.listComments)
*
* @param string $fileId The ID of the file.
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Drive_CommentList
*/
public function listComments($fileId, $optParams = array())
{
$params = array('fileId' => $fileId);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Drive_CommentList");
}
/**
* Updates a comment with patch semantics. (comments.update)
*
* @param string $fileId The ID of the file.
* @param string $commentId The ID of the comment.
* @param Google_Service_Drive_Comment $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Drive_Comment
*/
public function update($fileId, $commentId, Google_Service_Drive_Comment $postBody, $optParams = array())
{
$params = array('fileId' => $fileId, 'commentId' => $commentId, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('update', array($params), "Google_Service_Drive_Comment");
}
}
|