Module: Slack::Web::Api::Endpoints::Pins

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/pins.rb

Instance Method Summary collapse

Instance Method Details

#pins_add(options = {}) ⇒ Object

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.

Options Hash (options):

  • :channel (channel)

    Channel to pin the item in.

  • :file (file)

    File to pin.

  • :file_comment (Object)

    File comment to pin.

  • :timestamp (Object)

    Timestamp of the message to pin.

See Also:


22
23
24
25
26
# 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 = {}) ⇒ Object

This method lists the items pinned to a channel.

Options Hash (options):

  • :channel (channel)

    Channel to get pinned items for.

See Also:


35
36
37
38
39
# 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 = {}) ⇒ Object

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.

Options Hash (options):

  • :channel (channel)

    Channel where the item is pinned to.

  • :file (file)

    File to un-pin.

  • :file_comment (Object)

    File comment to un-pin.

  • :timestamp (Object)

    Timestamp of the message to un-pin.

See Also:


55
56
57
58
59
# 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