module Slack::Web::Api::Endpoints::Stars

Public Instance Methods

stars_add(options = {}) click to toggle source

This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified.

@option options [file] :file

File to add star to.

@option options [Object] :file_comment

File comment to add star to.

@option options [channel] :channel

Channel to add star to, or channel where the message to add star to was posted (used with timestamp).

@option options [Object] :timestamp

Timestamp of the message to add star to.

@see api.slack.com/methods/stars.add @see github.com/dblock/slack-api-ref/blob/master/methods/stars.add.json

# File lib/slack/web/api/endpoints/stars.rb, line 22
def stars_add(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('stars.add', options)
end
stars_list(options = {}) click to toggle source

This method lists the items starred by a user.

@option options [user] :user

Show stars by this user. Defaults to the authed user.

@see api.slack.com/methods/stars.list @see github.com/dblock/slack-api-ref/blob/master/methods/stars.list.json

# File lib/slack/web/api/endpoints/stars.rb, line 34
def stars_list(options = {})
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('stars.list', options)
end
stars_remove(options = {}) click to toggle source

This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified.

@option options [file] :file

File to remove star from.

@option options [Object] :file_comment

File comment to remove star from.

@option options [channel] :channel

Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).

@option options [Object] :timestamp

Timestamp of the message to remove star from.

@see api.slack.com/methods/stars.remove @see github.com/dblock/slack-api-ref/blob/master/methods/stars.remove.json

# File lib/slack/web/api/endpoints/stars.rb, line 53
def stars_remove(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('stars.remove', options)
end