Module: Slack::Web::Api::Endpoints::Channels
- Included in:
- Slack::Web::Api::Endpoints
- Defined in:
- lib/slack/web/api/endpoints/channels.rb
Instance Method Summary collapse
-
#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.
16 17 18 19 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 16 def channels_archive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? post('channels.archive', ) end |
#channels_create(options = {}) ⇒ Object
Creates a channel.
29 30 31 32 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 29 def channels_create( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('channels.create', ) end |
#channels_history(options = {}) ⇒ Object
Fetches history of messages and events from a channel.
48 49 50 51 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 48 def channels_history( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? post('channels.history', ) end |
#channels_info(options = {}) ⇒ Object
Gets information about a channel.
61 62 63 64 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 61 def channels_info( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? post('channels.info', ) end |
#channels_invite(options = {}) ⇒ Object
Invites a user to a channel.
76 77 78 79 80 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 76 def channels_invite( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :user missing') if [:user].nil? post('channels.invite', ) end |
#channels_join(options = {}) ⇒ Object
Joins a channel, creating it if needed.
90 91 92 93 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 90 def channels_join( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('channels.join', ) end |
#channels_kick(options = {}) ⇒ Object
Removes a user from a channel.
105 106 107 108 109 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 105 def channels_kick( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :user missing') if [:user].nil? post('channels.kick', ) end |
#channels_leave(options = {}) ⇒ Object
Leaves a channel.
119 120 121 122 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 119 def channels_leave( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? post('channels.leave', ) end |
#channels_list(options = {}) ⇒ Object
Lists all channels in a Slack team.
132 133 134 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 132 def channels_list( = {}) post('channels.list', ) end |
#channels_mark(options = {}) ⇒ Object
Sets the read cursor in a channel.
146 147 148 149 150 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 146 def channels_mark( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :ts missing') if [:ts].nil? post('channels.mark', ) end |
#channels_rename(options = {}) ⇒ Object
Renames a channel.
162 163 164 165 166 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 162 def channels_rename( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('channels.rename', ) end |
#channels_setPurpose(options = {}) ⇒ Object
Sets the purpose for a channel.
178 179 180 181 182 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 178 def channels_setPurpose( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :purpose missing') if [:purpose].nil? post('channels.setPurpose', ) end |
#channels_setTopic(options = {}) ⇒ Object
Sets the topic for a channel.
194 195 196 197 198 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 194 def channels_setTopic( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :topic missing') if [:topic].nil? post('channels.setTopic', ) end |
#channels_unarchive(options = {}) ⇒ Object
Unarchives a channel.
208 209 210 211 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 208 def channels_unarchive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? post('channels.unarchive', ) end |