Slack. Web. Files. Comments
(SlackKit v0.25.0-alpha.0)
View Source
Summary
Functions
Add a comment to an existing file.
Deletes an existing comment on a file.
Edit an existing file comment.
Functions
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- Thecommentfield was empty.
Deletes an existing comment on a file.
Required Params
file- File to delete a comment from. ex:F1234567890id- The comment to delete. ex:Fc1234567890
Errors the API can return:
token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.invalid_arg_name- The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than_. If you get this error, it is typically an indication that you have made a very malformed API call.two_factor_setup_required- Two factor setup is required.cant_delete- The requested comment could not be deleted.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.fatal_error- The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.deprecated_endpoint- The endpoint has been deprecated.ratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.invalid_arguments- The method was called with invalid arguments.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.not_authed- No authentication token provided.internal_error- The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.enterprise_is_restricted- The method cannot be called from an Enterprise.no_permission- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.access_denied- Access to a resource specified in the request is denied.team_added_to_org- The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredfile_deleted- The requested file was previously deleted.invalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.file_not_found- The requested file could not be found.not_allowed_token_type- The token type used in this request is not allowed.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.invalid_auth- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
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:F1234567890id- 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- Thecommentfield was empty.