module Slack::Endpoint::Channels

Public Instance Methods

channels_archive(options={}) click to toggle source

Archives a channel.

@option options [Object] :channel

Channel to archive

@see api.slack.com/methods/channels.archive @see github.com/aki017/slack-api-docs/blob/master/methods/channels.archive.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.archive.json

# File lib/slack/endpoint/channels.rb, line 14
def channels_archive(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("channels.archive", options)
end
channels_create(options={}) click to toggle source

Creates a channel.

@option options [Object] :name

Name of channel to create

@option options [Object] :validate

Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

@see api.slack.com/methods/channels.create @see github.com/aki017/slack-api-docs/blob/master/methods/channels.create.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.create.json

# File lib/slack/endpoint/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={}) click to toggle source

Fetches history of messages and events from a channel.

@option options [Object] :channel

Channel to fetch history for.

@option options [Object] :count

Number of messages to return, between 1 and 1000.

@option options [Object] :inclusive

Include messages with latest or oldest timestamp in results.

@option options [Object] :latest

End of time range of messages to include in results.

@option options [Object] :oldest

Start of time range of messages to include in results.

@option options [Object] :unreads

Include unread_count_display in the output?

@see api.slack.com/methods/channels.history @see github.com/aki017/slack-api-docs/blob/master/methods/channels.history.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.history.json

# File lib/slack/endpoint/channels.rb, line 52
def channels_history(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("channels.history", options)
end
channels_info(options={}) click to toggle source

Gets information about a channel.

@option options [Object] :channel

Channel to get info on

@option options [Object] :include_locale

Set this to true to receive the locale for this channel. Defaults to false

@see api.slack.com/methods/channels.info @see github.com/aki017/slack-api-docs/blob/master/methods/channels.info.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.info.json

# File lib/slack/endpoint/channels.rb, line 67
def channels_info(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("channels.info", options)
end
channels_invite(options={}) click to toggle source

Invites a user to a channel.

@option options [Object] :channel

Channel to invite user to.

@option options [Object] :user

User to invite to channel.

@see api.slack.com/methods/channels.invite @see github.com/aki017/slack-api-docs/blob/master/methods/channels.invite.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.invite.json

# File lib/slack/endpoint/channels.rb, line 82
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={}) click to toggle source

Joins a channel, creating it if needed.

@option options [Object] :name

Name of channel to join

@option options [Object] :validate

Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

@see api.slack.com/methods/channels.join @see github.com/aki017/slack-api-docs/blob/master/methods/channels.join.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.join.json

# File lib/slack/endpoint/channels.rb, line 98
def channels_join(options={})
  throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
  post("channels.join", options)
end
channels_kick(options={}) click to toggle source

Removes a user from a channel.

@option options [Object] :channel

Channel to remove user from.

@option options [Object] :user

User to remove from channel.

@see api.slack.com/methods/channels.kick @see github.com/aki017/slack-api-docs/blob/master/methods/channels.kick.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.kick.json

# File lib/slack/endpoint/channels.rb, line 113
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={}) click to toggle source

Leaves a channel.

@option options [Object] :channel

Channel to leave

@see api.slack.com/methods/channels.leave @see github.com/aki017/slack-api-docs/blob/master/methods/channels.leave.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.leave.json

# File lib/slack/endpoint/channels.rb, line 127
def channels_leave(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("channels.leave", options)
end
channels_list(options={}) click to toggle source

Lists all channels in a Slack team.

@option options [Object] :cursor

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

@option options [Object] :exclude_archived

Exclude archived channels from the list

@option options [Object] :exclude_members

Exclude the members collection from each channel

@option options [Object] :limit

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

@see api.slack.com/methods/channels.list @see github.com/aki017/slack-api-docs/blob/master/methods/channels.list.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.list.json

# File lib/slack/endpoint/channels.rb, line 146
def channels_list(options={})
  post("channels.list", options)
end
channels_mark(options={}) click to toggle source

Sets the read cursor in a channel.

@option options [Object] :channel

Channel to set reading cursor in.

@option options [Object] :ts

Timestamp of the most recently seen message.

@see api.slack.com/methods/channels.mark @see github.com/aki017/slack-api-docs/blob/master/methods/channels.mark.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.mark.json

# File lib/slack/endpoint/channels.rb, line 160
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={}) click to toggle source

Renames a channel.

@option options [Object] :channel

Channel to rename

@option options [Object] :name

New name for channel.

@option options [Object] :validate

Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

@see api.slack.com/methods/channels.rename @see github.com/aki017/slack-api-docs/blob/master/methods/channels.rename.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.rename.json

# File lib/slack/endpoint/channels.rb, line 178
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_replies(options={}) click to toggle source

Retrieve a thread of messages posted to a channel

@option options [Object] :channel

Channel to fetch thread from

@option options [Object] :thread_ts

Unique identifier of a thread's parent message

@see api.slack.com/methods/channels.replies @see github.com/aki017/slack-api-docs/blob/master/methods/channels.replies.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.replies.json

# File lib/slack/endpoint/channels.rb, line 194
def channels_replies(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :thread_ts missing") if options[:thread_ts].nil?
  post("channels.replies", options)
end
channels_setPurpose(options={}) click to toggle source

Sets the purpose for a channel.

@option options [Object] :channel

Channel to set the purpose of

@option options [Object] :purpose

The new purpose

@see api.slack.com/methods/channels.setPurpose @see github.com/aki017/slack-api-docs/blob/master/methods/channels.setPurpose.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.setPurpose.json

# File lib/slack/endpoint/channels.rb, line 210
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={}) click to toggle source

Sets the topic for a channel.

@option options [Object] :channel

Channel to set the topic of

@option options [Object] :topic

The new topic

@see api.slack.com/methods/channels.setTopic @see github.com/aki017/slack-api-docs/blob/master/methods/channels.setTopic.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.setTopic.json

# File lib/slack/endpoint/channels.rb, line 226
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={}) click to toggle source

Unarchives a channel.

@option options [Object] :channel

Channel to unarchive

@see api.slack.com/methods/channels.unarchive @see github.com/aki017/slack-api-docs/blob/master/methods/channels.unarchive.md @see github.com/aki017/slack-api-docs/blob/master/methods/channels.unarchive.json

# File lib/slack/endpoint/channels.rb, line 240
def channels_unarchive(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("channels.unarchive", options)
end