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
This method archives a channel.
-
#channels_create(options = {}) ⇒ Object
This method is used to create a channel.
-
#channels_history(options = {}) ⇒ Object
This method returns a portion of message events from the specified channel.
-
#channels_info(options = {}) ⇒ Object
This method returns information about a team channel.
-
#channels_invite(options = {}) ⇒ Object
This method is used to invite a user to a channel.
-
#channels_join(options = {}) ⇒ Object
This method is used to join a channel.
-
#channels_kick(options = {}) ⇒ Object
This method allows a user to remove another member from a team channel.
-
#channels_leave(options = {}) ⇒ Object
This method is used to leave a channel.
-
#channels_list(options = {}) ⇒ Object
This method returns a list of all channels in the team.
-
#channels_mark(options = {}) ⇒ Object
This method moves the read cursor in a channel.
-
#channels_rename(options = {}) ⇒ Object
This method renames a team channel.
-
#channels_replies(options = {}) ⇒ Object
This method returns an entire thread (a message plus all the messages in reply to it).
-
#channels_setPurpose(options = {}) ⇒ Object
This method is used to change the purpose of a channel.
-
#channels_setTopic(options = {}) ⇒ Object
This method is used to change the topic of a channel.
-
#channels_unarchive(options = {}) ⇒ Object
This method unarchives a channel.
Instance Method Details
#channels_archive(options = {}) ⇒ Object
This method archives a channel.
15 16 17 18 19 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 15 def channels_archive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.archive', ) end |
#channels_create(options = {}) ⇒ Object
This method is used to create a channel.
28 29 30 31 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 28 def channels_create( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('channels.create', ) end |
#channels_history(options = {}) ⇒ Object
This method returns a portion of message events from the specified channel.
48 49 50 51 52 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 48 def channels_history( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.history', ) end |
#channels_info(options = {}) ⇒ Object
This method returns information about a team channel.
61 62 63 64 65 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 61 def channels_info( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.info', ) end |
#channels_invite(options = {}) ⇒ Object
This method is used to invite a user to a channel. The calling user must be a member of the channel.
76 77 78 79 80 81 82 |
# 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? = .merge(channel: channels_id()['channel']['id']) if [:channel] = .merge(user: users_id()['user']['id']) if [:user] post('channels.invite', ) end |
#channels_join(options = {}) ⇒ Object
This method is used to join a channel. If the channel does not exist, it is created.
92 93 94 95 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 92 def channels_join( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('channels.join', ) end |
#channels_kick(options = {}) ⇒ Object
This method allows a user to remove another member from a team channel.
106 107 108 109 110 111 112 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 106 def channels_kick( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :user missing') if [:user].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] = .merge(user: users_id()['user']['id']) if [:user] post('channels.kick', ) end |
#channels_leave(options = {}) ⇒ Object
This method is used to leave a channel.
121 122 123 124 125 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 121 def channels_leave( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.leave', ) end |
#channels_list(options = {}) ⇒ Object
This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.
134 135 136 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 134 def channels_list( = {}) post('channels.list', ) end |
#channels_mark(options = {}) ⇒ Object
This method moves the read cursor in a channel.
147 148 149 150 151 152 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 147 def channels_mark( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :ts missing') if [:ts].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.mark', ) end |
#channels_rename(options = {}) ⇒ Object
This method renames a team channel.
163 164 165 166 167 168 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 163 def channels_rename( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :name missing') if [:name].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.rename', ) end |
#channels_replies(options = {}) ⇒ Object
This method returns an entire thread (a message plus all the messages in reply to it).
179 180 181 182 183 184 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 179 def channels_replies( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :thread_ts missing') if [:thread_ts].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.replies', ) end |
#channels_setPurpose(options = {}) ⇒ Object
This method is used to change the purpose of a channel. The calling user must be a member of the channel.
195 196 197 198 199 200 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 195 def channels_setPurpose( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :purpose missing') if [:purpose].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.setPurpose', ) end |
#channels_setTopic(options = {}) ⇒ Object
This method is used to change the topic of a channel. The calling user must be a member of the channel.
211 212 213 214 215 216 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 211 def channels_setTopic( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :topic missing') if [:topic].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.setTopic', ) end |
#channels_unarchive(options = {}) ⇒ Object
This method unarchives a channel. The calling user is added to the channel.
225 226 227 228 229 |
# File 'lib/slack/web/api/endpoints/channels.rb', line 225 def channels_unarchive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('channels.unarchive', ) end |