Slack

v0.23.5

Slack v0.23.5 Slack.Web.Reactions View Source

Link to this section Summary

Functions

add(name, optional_params \\ %{})

Adds a reaction to an item

get(optional_params \\ %{})

Gets reactions for an item

list(optional_params \\ %{})

Lists reactions made by a user

remove(name, optional_params \\ %{})

Removes a reaction from an item

Link to this section Functions

Link to this function

add(name, optional_params \\ %{}) View Source

Adds a reaction to an item.

Required Params

  • name - Reaction (emoji) name. ex: thumbsup

Optional Params

  • channel - Channel where the message to add reaction to was posted.
  • file - File to add reaction to.
  • file_comment - File comment to add reaction to.
  • timestamp - Timestamp of the message to add reaction to.

Errors the API can return:

  • already_reacted - The specified item already has the user/reaction combination.
  • bad_timestamp - Value passed for timestamp was invalid.
  • file_comment_not_found - File comment specified by file_comment does not exist.
  • file_not_found - File specified by file does not exist.
  • invalid_name - Value passed for name was invalid.
  • message_not_found - Message specified by channel and timestamp does not exist.
  • no_item_specified - file, file_comment, or combination of channel and timestamp was not specified.
  • too_many_emoji - The limit for distinct reactions (i.e emoji) on the item has been reached.
  • too_many_reactions - The limit for reactions a person may add to the item has been reached.
Link to this function

get(optional_params \\ %{}) View Source

Gets reactions for an item.

Optional Params

  • channel - Channel where the message to get reactions for was posted.
  • file - File to get reactions for.
  • file_comment - File comment to get reactions for.
  • full - If true always return the complete reaction list.
  • timestamp - Timestamp of the message to get reactions for.

Errors the API can return:

  • bad_timestamp - Value passed for timestamp was invalid.
  • file_comment_not_found - File comment specified by file_comment does not exist.
  • file_not_found - File specified by file does not exist.
  • message_not_found - Message specified by channel and timestamp does not exist.
  • no_item_specified - file, file_comment, or combination of channel and timestamp was not specified.
Link to this function

list(optional_params \\ %{}) View Source

Lists reactions made by a user.

Optional Params

  • full - If true always return the complete reaction list.
  • user - Show reactions made by this user. Defaults to the authed user.

Errors the API can return:

  • user_not_found - Value passed for user was invalid.
Link to this function

remove(name, optional_params \\ %{}) View Source

Removes a reaction from an item.

Required Params

  • name - Reaction (emoji) name. ex: thumbsup

Optional Params

  • channel - Channel where the message to remove reaction from was posted.
  • file - File to remove reaction from.
  • file_comment - File comment to remove reaction from.
  • timestamp - Timestamp of the message to remove reaction from.

Errors the API can return:

  • bad_timestamp - Value passed for timestamp was invalid.
  • file_comment_not_found - File comment specified by file_comment does not exist.
  • file_not_found - File specified by file does not exist.
  • invalid_name - Value passed for name was invalid.
  • message_not_found - Message specified by channel and timestamp does not exist.
  • no_item_specified - file, file_comment, or combination of channel and timestamp was not specified.
  • no_reaction - The specified item does not have the user/reaction combination.