module Slack::Web::Api::Endpoints::Conversations

def conversations_archive(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.archive.json -
    See: https://api.slack.com/methods/conversations.archive -

Options Hash: (**options)
  • :channel (channel) --
def conversations_archive(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('conversations.archive', options)
end

def conversations_close(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.close.json -
    See: https://api.slack.com/methods/conversations.close -

Options Hash: (**options)
  • :channel (channel) --
def conversations_close(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('conversations.close', options)
end

def conversations_create(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.create.json -
    See: https://api.slack.com/methods/conversations.create -

Options Hash: (**options)
  • :user_ids (Object) --
  • :is_private (Object) --
  • :name (Object) --
def conversations_create(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('conversations.create', options)
end

def conversations_history(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.history.json -
    See: https://api.slack.com/methods/conversations.history -

Options Hash: (**options)
  • :oldest (timestamp) --
  • :limit (Object) --
  • :latest (timestamp) --
  • :inclusive (Object) --
  • :cursor (Object) --
  • :channel (channel) --
def conversations_history(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :conversations_history, options).each do |page|
      yield page
    end
  else
    post('conversations.history', options)
  end
end

def conversations_info(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.info.json -
    See: https://api.slack.com/methods/conversations.info -

Options Hash: (**options)
  • :include_num_members (Object) --
  • :include_locale (Object) --
  • :channel (channel) --
def conversations_info(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('conversations.info', options)
end

def conversations_invite(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.invite.json -
    See: https://api.slack.com/methods/conversations.invite -

Options Hash: (**options)
  • :users (Object) --
  • :channel (channel) --
def conversations_invite(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.invite', options)
end

def conversations_join(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.join.json -
    See: https://api.slack.com/methods/conversations.join -

Options Hash: (**options)
  • :channel (channel) --
def conversations_join(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('conversations.join', options)
end

def conversations_kick(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.kick.json -
    See: https://api.slack.com/methods/conversations.kick -

Options Hash: (**options)
  • :user (user) --
  • :channel (channel) --
def conversations_kick(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('conversations.kick', options)
end

def conversations_leave(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.leave.json -
    See: https://api.slack.com/methods/conversations.leave -

Options Hash: (**options)
  • :channel (channel) --
def conversations_leave(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('conversations.leave', options)
end

def conversations_list(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.list.json -
    See: https://api.slack.com/methods/conversations.list -

Options Hash: (**options)
  • :types (Object) --
  • :limit (Object) --
  • :exclude_archived (Object) --
  • :cursor (Object) --
def conversations_list(options = {})
  if block_given?
    Pagination::Cursor.new(self, :conversations_list, options).each do |page|
      yield page
    end
  else
    post('conversations.list', options)
  end
end

def conversations_members(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.members.json -
    See: https://api.slack.com/methods/conversations.members -

Options Hash: (**options)
  • :limit (Object) --
  • :cursor (Object) --
  • :channel (channel) --
def conversations_members(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :conversations_members, options).each do |page|
      yield page
    end
  else
    post('conversations.members', options)
  end
end

def conversations_open(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.open.json -
    See: https://api.slack.com/methods/conversations.open -

Options Hash: (**options)
  • :users (Object) --
  • :return_im (Object) --
  • :channel (channel) --
def conversations_open(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.open', options)
end

def conversations_rename(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.rename.json -
    See: https://api.slack.com/methods/conversations.rename -

Options Hash: (**options)
  • :name (Object) --
  • :channel (channel) --
def conversations_rename(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.rename', options)
end

def conversations_replies(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.replies.json -
    See: https://api.slack.com/methods/conversations.replies -

Options Hash: (**options)
  • :oldest (timestamp) --
  • :limit (Object) --
  • :latest (timestamp) --
  • :inclusive (Object) --
  • :cursor (Object) --
  • :ts (timestamp) --
  • :channel (channel) --
def conversations_replies(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :conversations_replies, options).each do |page|
      yield page
    end
  else
    post('conversations.replies', options)
  end
end

def conversations_setPurpose(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.setPurpose.json -
    See: https://api.slack.com/methods/conversations.setPurpose -

Options Hash: (**options)
  • :purpose (Object) --
  • :channel (channel) --
def conversations_setPurpose(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.setPurpose', options)
end

def conversations_setTopic(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.setTopic.json -
    See: https://api.slack.com/methods/conversations.setTopic -

Options Hash: (**options)
  • :topic (Object) --
  • :channel (channel) --
def conversations_setTopic(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.setTopic', options)
end

def conversations_unarchive(options = {})

Other tags:
    See: https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.unarchive.json -
    See: https://api.slack.com/methods/conversations.unarchive -

Options Hash: (**options)
  • :channel (channel) --
def conversations_unarchive(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('conversations.unarchive', options)
end