Xlack.Web.Stars (xlack v0.1.0) View Source
Link to this section Summary
Link to this section Functions
Adds a star to an item.
Optional Params
channel- Channel to add star to, or channel where the message to add star to was posted (used withtimestamp).file- File to add star to.file_comment- File comment to add star to.timestamp- Timestamp of the message to add star to.
Errors the API can return:
already_starred- The specified item has already been starred by the authenticated user.bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- Channel, private group, or DM specified bychanneldoes not existfile_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,channelandtimestampwas not specified.
Lists stars for a user.
Optional Params
user- Show stars by this user. Defaults to the authed user.
Errors the API can return:
user_not_found- Value passed foruserwas invalid
Removes a star from an item.
Optional Params
channel- Channel to remove star from, or channel where the message to remove star from was posted (used withtimestamp).file- File to remove star from.file_comment- File comment to remove star from.timestamp- Timestamp of the message to remove star from.
Errors the API can return:
bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- Channel, private group, or DM specified bychanneldoes not existfile_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,channelandtimestampwas not specified.not_starred- The specified item is not currently starred by the authenticated user.