Module: Slack::Web::Api::Endpoints::Channels

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/channels.rb

Instance Method Summary

• #channels_archive(options = {}) ⇒ Object

  Archives a channel.

• #channels_create(options = {}) ⇒ Object

  Creates a channel.

• #channels_history(options = {}) ⇒ Object

  Fetches history of messages and events from a channel.

• #channels_info(options = {}) ⇒ Object

  Gets information about a channel.

• #channels_invite(options = {}) ⇒ Object

  Invites a user to a channel.

• #channels_join(options = {}) ⇒ Object

  Joins a channel, creating it if needed.

• #channels_kick(options = {}) ⇒ Object

  Removes a user from a channel.

• #channels_leave(options = {}) ⇒ Object

  Leaves a channel.

• #channels_list(options = {}) ⇒ Object

  Lists all channels in a Slack team.

• #channels_mark(options = {}) ⇒ Object

  Sets the read cursor in a channel.

• #channels_rename(options = {}) ⇒ Object

  Renames a channel.

• #channels_setPurpose(options = {}) ⇒ Object

  Sets the purpose for a channel.

• #channels_setTopic(options = {}) ⇒ Object

  Sets the topic for a channel.

• #channels_unarchive(options = {}) ⇒ Object

  Unarchives a channel.

Instance Method Details

#channels_archive(options = {}) ⇒ Object

Archives a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to archive

See Also:

• https://api.slack.com/methods/channels.archive
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 16

def channels_archive(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  post('channels.archive', options)
end

#channels_create(options = {}) ⇒ Object

Creates a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :name (Object) —

  Name of channel to create

See Also:

• https://api.slack.com/methods/channels.create
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 29

def channels_create(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('channels.create', options)
end

#channels_history(options = {}) ⇒ Object

Fetches history of messages and events from a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to fetch history for.

• :latest (timestamp) —

  Latest message timestamp to include in results.

• :oldest (timestamp) —

  Oldest message timestamp to include in results.

• :count (Object) —

  Number of messages to return, between 1 and 1000.

See Also:

• https://api.slack.com/methods/channels.history
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 48

def channels_history(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  post('channels.history', options)
end

#channels_info(options = {}) ⇒ Object

Gets information about a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to get info on

See Also:

• https://api.slack.com/methods/channels.info
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 61

def channels_info(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  post('channels.info', options)
end

#channels_invite(options = {}) ⇒ Object

Invites a user to a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to invite user to.

• :user (user) —

  User to invite to channel.

See Also:

• https://api.slack.com/methods/channels.invite
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 76

def channels_invite(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  post('channels.invite', options)
end

#channels_join(options = {}) ⇒ Object

Joins a channel, creating it if needed.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :name (Object) —

  Name of channel to join

See Also:

• https://api.slack.com/methods/channels.join
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 90

def channels_join(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('channels.join', options)
end

#channels_kick(options = {}) ⇒ Object

Removes a user from a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to remove user from.

• :user (user) —

  User to remove from channel.

See Also:

• https://api.slack.com/methods/channels.kick
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 105

def channels_kick(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  post('channels.kick', options)
end

#channels_leave(options = {}) ⇒ Object

Leaves a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to leave

See Also:

• https://api.slack.com/methods/channels.leave
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 119

def channels_leave(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  post('channels.leave', options)
end

#channels_list(options = {}) ⇒ Object

Lists all channels in a Slack team.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :exclude_archived (Object) —

  Don’t return archived channels.

See Also:

• https://api.slack.com/methods/channels.list
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 132

def channels_list(options = {})
  post('channels.list', options)
end

#channels_mark(options = {}) ⇒ Object

Sets the read cursor in a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to set reading cursor in.

• :ts (timestamp) —

  Timestamp of the most recently seen message.

See Also:

• https://api.slack.com/methods/channels.mark
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 146

def channels_mark(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
  post('channels.mark', options)
end

#channels_rename(options = {}) ⇒ Object

Renames a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to rename

• :name (Object) —

  New name for channel.

See Also:

• https://api.slack.com/methods/channels.rename
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 162

def channels_rename(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('channels.rename', options)
end

#channels_setPurpose(options = {}) ⇒ Object

Sets the purpose for a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to set the purpose of

• :purpose (Object) —

  The new purpose

See Also:

• https://api.slack.com/methods/channels.setPurpose
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 178

def channels_setPurpose(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
  post('channels.setPurpose', options)
end

#channels_setTopic(options = {}) ⇒ Object

Sets the topic for a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to set the topic of

• :topic (Object) —

  The new topic

See Also:

• https://api.slack.com/methods/channels.setTopic
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 194

def channels_setTopic(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
  post('channels.setTopic', options)
end

#channels_unarchive(options = {}) ⇒ Object

Unarchives a channel.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Channel to unarchive

See Also:

• https://api.slack.com/methods/channels.unarchive
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.md
• https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.json

# File 'lib/slack/web/api/endpoints/channels.rb', line 208

def channels_unarchive(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  post('channels.unarchive', options)
end