Module: Slack::Web::Api::Endpoints::Stars

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/stars.rb

Instance Method Summary

• #stars_add(options = {}) ⇒ Object

  This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.

• #stars_list(options = {}) ⇒ Object

  This method lists the items starred by the authed user.

• #stars_remove(options = {}) ⇒ Object

  This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.

Instance Method Details

#stars_add(options = {}) ⇒ Object

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.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

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

• :file (file) —

  File to add star to.

• :file_comment (Object) —

  File comment to add star to.

• :timestamp (Object) —

  Timestamp of the message to add star to.

See Also:

• https://api.slack.com/methods/stars.add
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/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 = {}) ⇒ Object

This method lists the items starred by the authed user.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :cursor (Object) —

  Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request’s response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first “page” of the collection. See pagination for more details.

• :limit (Object) —

  The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn’t been reached.

See Also:

• https://api.slack.com/methods/stars.list
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.list.json

# File 'lib/slack/web/api/endpoints/stars.rb', line 36

def stars_list(options = {})
  if block_given?
    Pagination::Cursor.new(self, :stars_list, options).each do |page|
      yield page
    end
  else
    post('stars.list', options)
  end
end

#stars_remove(options = {}) ⇒ Object

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.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

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

• :file (file) —

  File to remove star from.

• :file_comment (Object) —

  File comment to remove star from.

• :timestamp (Object) —

  Timestamp of the message to remove star from.

See Also:

• https://api.slack.com/methods/stars.remove
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.remove.json

# File 'lib/slack/web/api/endpoints/stars.rb', line 60

def stars_remove(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('stars.remove', options)
end