Xlack.Web.Reactions (xlack v0.1.0) View Source
Link to this section Summary
Functions
Adds a reaction to an item.
Gets reactions for an item.
Lists reactions made by a user.
Removes a reaction from an item.
Link to this section Functions
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 fortimestampwas invalid.file_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.invalid_name- Value passed fornamewas invalid.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified-file,file_comment, or combination ofchannelandtimestampwas 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.
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 fortimestampwas invalid.file_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified-file,file_comment, or combination ofchannelandtimestampwas not specified.
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 foruserwas invalid.
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 fortimestampwas invalid.file_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.invalid_name- Value passed fornamewas invalid.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified-file,file_comment, or combination ofchannelandtimestampwas not specified.no_reaction- The specified item does not have the user/reaction combination.