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

API calls for all endpoints tagged Comments.

Link to this section Summary

Link to this section Functions

Link to this function drive_comments_create(connection, file_id, opts \\ []) View Source
drive_comments_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()} | {:error, Tesla.Env.t()}

Creates a new comment on a file.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • file_id (String.t): The ID of the file.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Comment):

Returns

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

Link to this function drive_comments_delete(connection, file_id, comment_id, opts \\ []) View Source
drive_comments_delete(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a comment.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • file_id (String.t): The ID of the file.
  • comment_id (String.t): The ID of the comment.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

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

Link to this function drive_comments_get(connection, file_id, comment_id, opts \\ []) View Source
drive_comments_get(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()} | {:error, Tesla.Env.t()}

Gets a comment by ID.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • file_id (String.t): The ID of the file.
  • comment_id (String.t): The ID of the comment.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeDeleted (boolean()): Whether to return deleted comments. Deleted comments will not include their original content.

Returns

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

Link to this function drive_comments_list(connection, file_id, opts \\ []) View Source
drive_comments_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.CommentList.t()} | {:error, Tesla.Env.t()}

Lists a file's comments.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • file_id (String.t): The ID of the file.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeDeleted (boolean()): Whether to include deleted comments. Deleted comments will not include their original content.
    • :pageSize (integer()): The maximum number of comments to return per page.
    • :pageToken (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 (String.t): The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).

Returns

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

Link to this function drive_comments_update(connection, file_id, comment_id, opts \\ []) View Source
drive_comments_update(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Comment.t()} | {:error, Tesla.Env.t()}

Updates a comment with patch semantics.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • file_id (String.t): The ID of the file.
  • comment_id (String.t): The ID of the comment.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Comment):

Returns

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