Google_Service_Drive_Comments_Resource

The "comments" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Drive.php  
  1. class Google_Service_Drive_Comments_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes a comment. (comments.delete) 
  5. * @param string $fileId The ID of the file. 
  6. * @param string $commentId The ID of the comment. 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($fileId, $commentId, $optParams = array()) 
  10. $params = array('fileId' => $fileId, 'commentId' => $commentId); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Gets a comment by ID. (comments.get) 
  16. * @param string $fileId The ID of the file. 
  17. * @param string $commentId The ID of the comment. 
  18. * @param array $optParams Optional parameters. 
  19. * @opt_param bool includeDeleted If set, this will succeed when retrieving a 
  20. * deleted comment, and will include any deleted replies. 
  21. * @return Google_Service_Drive_Comment 
  22. */ 
  23. public function get($fileId, $commentId, $optParams = array()) 
  24. $params = array('fileId' => $fileId, 'commentId' => $commentId); 
  25. $params = array_merge($params, $optParams); 
  26. return $this->call('get', array($params), "Google_Service_Drive_Comment"); 
  27.  
  28. /** 
  29. * Creates a new comment on the given file. (comments.insert) 
  30. * @param string $fileId The ID of the file. 
  31. * @param Google_Comment $postBody 
  32. * @param array $optParams Optional parameters. 
  33. * @return Google_Service_Drive_Comment 
  34. */ 
  35. public function insert($fileId, Google_Service_Drive_Comment $postBody, $optParams = array()) 
  36. $params = array('fileId' => $fileId, 'postBody' => $postBody); 
  37. $params = array_merge($params, $optParams); 
  38. return $this->call('insert', array($params), "Google_Service_Drive_Comment"); 
  39.  
  40. /** 
  41. * Lists a file's comments. (comments.listComments) 
  42. * @param string $fileId The ID of the file. 
  43. * @param array $optParams Optional parameters. 
  44. * @opt_param string pageToken The continuation token, used to page through 
  45. * large result sets. To get the next page of results, set this parameter to the 
  46. * value of "nextPageToken" from the previous response. 
  47. * @opt_param string updatedMin Only discussions that were updated after this 
  48. * timestamp will be returned. Formatted as an RFC 3339 timestamp. 
  49. * @opt_param bool includeDeleted If set, all comments and replies, including 
  50. * deleted comments and replies (with content stripped) will be returned. 
  51. * @opt_param int maxResults The maximum number of discussions to include in the 
  52. * response, used for paging. 
  53. * @return Google_Service_Drive_CommentList 
  54. */ 
  55. public function listComments($fileId, $optParams = array()) 
  56. $params = array('fileId' => $fileId); 
  57. $params = array_merge($params, $optParams); 
  58. return $this->call('list', array($params), "Google_Service_Drive_CommentList"); 
  59.  
  60. /** 
  61. * Updates an existing comment. This method supports patch semantics. 
  62. * (comments.patch) 
  63. * @param string $fileId The ID of the file. 
  64. * @param string $commentId The ID of the comment. 
  65. * @param Google_Comment $postBody 
  66. * @param array $optParams Optional parameters. 
  67. * @return Google_Service_Drive_Comment 
  68. */ 
  69. public function patch($fileId, $commentId, Google_Service_Drive_Comment $postBody, $optParams = array()) 
  70. $params = array('fileId' => $fileId, 'commentId' => $commentId, 'postBody' => $postBody); 
  71. $params = array_merge($params, $optParams); 
  72. return $this->call('patch', array($params), "Google_Service_Drive_Comment"); 
  73.  
  74. /** 
  75. * Updates an existing comment. (comments.update) 
  76. * @param string $fileId The ID of the file. 
  77. * @param string $commentId The ID of the comment. 
  78. * @param Google_Comment $postBody 
  79. * @param array $optParams Optional parameters. 
  80. * @return Google_Service_Drive_Comment 
  81. */ 
  82. public function update($fileId, $commentId, Google_Service_Drive_Comment $postBody, $optParams = array()) 
  83. $params = array('fileId' => $fileId, 'commentId' => $commentId, 'postBody' => $postBody); 
  84. $params = array_merge($params, $optParams); 
  85. return $this->call('update', array($params), "Google_Service_Drive_Comment");