Xlack.Web.Files.Comments (xlack v0.1.0) View Source

Link to this section Summary

Functions

add(comment, file, optional_params \\ %{})

Add a comment to an existing file.

delete(file, id, optional_params \\ %{})

Deletes an existing comment on a file.

edit(comment, file, id, optional_params \\ %{})

Edit an existing file comment.

Link to this section Functions

add(comment, file, optional_params \\ %{})

Add a comment to an existing file.

Required Params

comment - Text of the comment to add. ex: Everyone should take a moment to read this file.
file - File to add a comment to. ex: F1234567890

Errors the API can return:

file_deleted - The requested file was previously deleted.
file_not_found - The requested file could not be found.
no_comment - The comment field was empty.

delete(file, id, optional_params \\ %{})

Deletes an existing comment on a file.

Required Params

file - File to delete a comment from. ex: F1234567890
id - The comment to delete. ex: Fc1234567890

Errors the API can return:

cant_delete - The requested comment could not be deleted.
file_deleted - The requested file was previously deleted.
file_not_found - The requested file could not be found.

edit(comment, file, id, optional_params \\ %{})

Edit an existing file comment.

Required Params

comment - Text of the comment to edit. ex: Everyone should take a moment to read this file, seriously.
file - File containing the comment to edit. ex: F1234567890
id - The comment to edit. ex: Fc1234567890

Errors the API can return:

cant_edit - The requested file could not be found.
edit_window_closed - The timeframe for editing the comment has expired.
file_deleted - The requested file was previously deleted.
file_not_found - The requested file could not be found.
no_comment - The comment field was empty.