Struct Comments 

pub struct Comments {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Comments

pub async fn list( &self, file_id: &str, include_deleted: bool, page_size: i64, page_token: &str, start_modified_time: &str, ) -> Result<Response<Vec<Comment>>, ClientError>

This function performs a GET to the /files/{fileId}/comments endpoint.

Lists a file’s comments.

Parameters:

• file_id: &str – A link to this theme’s background image.
• include_deleted: bool – Whether to include deleted comments. Deleted comments will not include their original content.
• page_size: i64 – A map of maximum import sizes by MIME type, in bytes.
• page_token: &str – 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.
• start_modified_time: &str – The minimum value of ‘modifiedTime’ for the result comments (RFC 3339 date-time).

pub async fn list_all( &self, file_id: &str, include_deleted: bool, start_modified_time: &str, ) -> Result<Response<Vec<Comment>>, ClientError>

This function performs a GET to the /files/{fileId}/comments endpoint.

As opposed to list, this function returns all the pages of the request at once.

Lists a file’s comments.

pub async fn create( &self, file_id: &str, body: &Comment, ) -> Result<Response<Comment>, ClientError>

This function performs a POST to the /files/{fileId}/comments endpoint.

Creates a new comment on a file.

Parameters:

• file_id: &str – A link to this theme’s background image.

pub async fn get( &self, file_id: &str, comment_id: &str, include_deleted: bool, ) -> Result<Response<Comment>, ClientError>

This function performs a GET to the /files/{fileId}/comments/{commentId} endpoint.

Gets a comment by ID.

Parameters:

• file_id: &str – A link to this theme’s background image.
• comment_id: &str – A link to this theme’s background image.
• include_deleted: bool – Whether to return deleted comments. Deleted comments will not include their original content.

pub async fn delete( &self, file_id: &str, comment_id: &str, ) -> Result<Response<()>, ClientError>

This function performs a DELETE to the /files/{fileId}/comments/{commentId} endpoint.

Deletes a comment.

Parameters:

• file_id: &str – A link to this theme’s background image.
• comment_id: &str – A link to this theme’s background image.

pub async fn update( &self, file_id: &str, comment_id: &str, body: &Comment, ) -> Result<Response<Comment>, ClientError>

This function performs a PATCH to the /files/{fileId}/comments/{commentId} endpoint.

Updates a comment with patch semantics.

Parameters:

• file_id: &str – A link to this theme’s background image.
• comment_id: &str – A link to this theme’s background image.