Slack

v0.23.5

Slack v0.23.5 Slack.Web.Stars View Source

Link to this section Summary

Functions

add(optional_params \\ %{})

Adds a star to an item

list(optional_params \\ %{})

Lists stars for a user

remove(optional_params \\ %{})

Removes a star from an item

Link to this section Functions

Link to this function

add(optional_params \\ %{}) View Source

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 with timestamp).
  • 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 for timestamp was invalid.
  • channel_not_found - Channel, private group, or DM specified by channel does not exist
  • 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, channel and timestamp was not specified.
Link to this function

list(optional_params \\ %{}) View Source

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 for user was invalid
Link to this function

remove(optional_params \\ %{}) View Source

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 with timestamp).
  • 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 for timestamp was invalid.
  • channel_not_found - Channel, private group, or DM specified by channel does not exist
  • 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, channel and timestamp was not specified.
  • not_starred - The specified item is not currently starred by the authenticated user.