google_api_drive v0.15.0 GoogleApi.Drive.V3.Api.Comments View Source

API calls for all endpoints tagged Comments.

Link to this section Summary

Functions

drive_comments_create(connection, file_id, optional_params \\ [], opts \\ [])

Creates a new comment on a file.

drive_comments_delete(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Deletes a comment.

drive_comments_get(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Gets a comment by ID.

drive_comments_list(connection, file_id, optional_params \\ [], opts \\ [])

Lists a file's comments.

drive_comments_update(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Updates a comment with patch semantics.

Link to this section Functions

drive_comments_create(connection, file_id, optional_params \\ [], opts \\ [])

Specs

drive_comments_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new comment on a file.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Drive.V3.Model.Comment.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Comment{}} on success
{:error, info} on failure

drive_comments_delete(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Specs

drive_comments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Deletes a comment.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
comment_id (type: String.t) - The ID of the comment.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

drive_comments_get(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Specs

drive_comments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a comment by ID.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
comment_id (type: String.t) - The ID of the comment.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :includeDeleted (type: boolean()) - Whether to return deleted comments. Deleted comments will not include their original content.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Comment{}} on success
{:error, info} on failure

drive_comments_list(connection, file_id, optional_params \\ [], opts \\ [])

Specs

drive_comments_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.CommentList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists a file's comments.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :includeDeleted (type: boolean()) - Whether to include deleted comments. Deleted comments will not include their original content.
- :pageSize (type: integer()) - The maximum number of comments to return per page.
- :pageToken (type: String.t) - 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.
- :startModifiedTime (type: String.t) - The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.CommentList{}} on success
{:error, info} on failure

drive_comments_update(connection, file_id, comment_id, optional_params \\ [], opts \\ [])

Specs

drive_comments_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a comment with patch semantics.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
comment_id (type: String.t) - The ID of the comment.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Drive.V3.Model.Comment.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Comment{}} on success
{:error, info} on failure