module Slack::Web::Stars

Module for the stars methods.

Constants

SCOPE

Endpoint scope

Public Instance Methods

stars_add(params = {}) 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.

@param [Hash] params

API call arguments

@option params [Object] 'file'

File to add star to.

@option params [Object] 'file_comment'

File comment to add star to.

@option params [Object] 'channel'

Channel to add star to, or channel where the message to add star to was posted

@option params [Object] 'timestamp'

Timestamp of the message to add star to.

@see api.slack.com/methods/stars.add

# File lib/slack/web/stars.rb, line 26
def stars_add(params = {})
  response = @session.do_post "#{SCOPE}.add", params
  Slack.parse_response(response)
end
stars_list(params = {}) click to toggle source

Lists stars for a user.

@param [Hash] params

API call arguments

@option params [user] 'user'

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

@option params [Object] 'count'

Number of items to return per page.

@option params [Object] 'page'

Page number of results to return.

@see api.slack.com/methods/stars.list

# File lib/slack/web/stars.rb, line 42
def stars_list(params = {})
  response = @session.do_post "#{SCOPE}.list", params
  Slack.parse_response(response)
end
stars_remove(params = {}) 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.

@param [Hash] params

API call arguments

@option params [Object] 'file'

File to remove star from.

@option params [Object] 'file_comment'

File comment to remove star from.

@option params [Object] 'channel'

Channel to remove star from, or channel where the message to remove star from was posted.

@option params [Object] 'timestamp'

Timestamp of the message to remove star from.

@see api.slack.com/methods/stars.remove

# File lib/slack/web/stars.rb, line 62
def stars_remove(params = {})
  response = @session.do_post "#{SCOPE}.remove", params
  Slack.parse_response(response)
end