module Slack::Web::Pins

Module for the pins methods.

Constants

SCOPE

Endpoint scope

Public Instance Methods

pins_add(params = {}) click to toggle source

This method pins an item (file, file comment, channel message, or group message) to a particular channel.

@param [Hash] params

API call arguments

@option params [Object] 'channel'

Channel to pin the item in.

@option params [Object] 'file'

File to pin.

@option params [Object] 'file_comment'

File comment to pin.

@option params [Object] 'timestamp'

Timestamp of the message to pin.

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

# File lib/slack/web/pins.rb, line 23
def pins_add(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.add", params
  Slack.parse_response(response)
end
pins_list(params = {}) click to toggle source

This method lists the items pinned to a channel.

@param [Hash] params

API call arguments

@option params [Object] 'channel'

Channel to get pinned items for.

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

# File lib/slack/web/pins.rb, line 37
def pins_list(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.list", params
  Slack.parse_response(response)
end
pins_remove(params = {}) click to toggle source

This method un-pins an item (file, file comment, channel message, or group message) from a channel.

@param [Hash] params

API call arguments

@option params [Object] 'channel'

Channel to pin the item in.

@option params [Object] 'file'

File to pin.

@option params [Object] 'file_comment'

File comment to pin.

@option params [Object] 'timestamp'

Timestamp of the message to pin.

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

# File lib/slack/web/pins.rb, line 58
def pins_remove(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.remove", params
  Slack.parse_response(response)
end