module Slack::Web::Api::Endpoints::Pins

Public Instance Methods

pins_add(options = {}) click to toggle source

This method pins an item (file, file comment, channel message, or group message) to a particular channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified.

@option options [channel] :channel

Channel to pin the item in.

@option options [file] :file

File to pin.

@option options [Object] :file_comment

File comment to pin.

@option options [Object] :timestamp

Timestamp of the message to pin.

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

# File lib/slack/web/api/endpoints/pins.rb, line 22
def pins_add(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('pins.add', options)
end
pins_list(options = {}) click to toggle source

This method lists the items pinned to a channel.

@option options [channel] :channel

Channel to get pinned items for.

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

# File lib/slack/web/api/endpoints/pins.rb, line 35
def pins_list(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('pins.list', options)
end
pins_remove(options = {}) click to toggle source

This method un-pins an item (file, file comment, channel message, or group message) from a channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified.

@option options [channel] :channel

Channel where the item is pinned to.

@option options [file] :file

File to un-pin.

@option options [Object] :file_comment

File comment to un-pin.

@option options [Object] :timestamp

Timestamp of the message to un-pin.

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

# File lib/slack/web/api/endpoints/pins.rb, line 55
def pins_remove(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('pins.remove', options)
end