Module: Slack::Web::Api::Endpoints::Groups
- Included in:
- Slack::Web::Api::Endpoints
- Defined in:
- lib/slack/web/api/endpoints/groups.rb
Instance Method Summary collapse
-
#groups_archive(options = {}) ⇒ Object
Archives a private channel.
-
#groups_close(options = {}) ⇒ Object
Closes a private channel.
-
#groups_create(options = {}) ⇒ Object
Creates a private channel.
-
#groups_createChild(options = {}) ⇒ Object
Clones and archives a private channel.
-
#groups_history(options = {}) ⇒ Object
Fetches history of messages and events from a private channel.
-
#groups_info(options = {}) ⇒ Object
Gets information about a private channel.
-
#groups_invite(options = {}) ⇒ Object
Invites a user to a private channel.
-
#groups_kick(options = {}) ⇒ Object
Removes a user from a private channel.
-
#groups_leave(options = {}) ⇒ Object
Leaves a private channel.
-
#groups_list(options = {}) ⇒ Object
Lists private channels that the calling user has access to.
-
#groups_mark(options = {}) ⇒ Object
Sets the read cursor in a private channel.
-
#groups_open(options = {}) ⇒ Object
Opens a private channel.
-
#groups_rename(options = {}) ⇒ Object
Renames a private channel.
-
#groups_replies(options = {}) ⇒ Object
Retrieve a thread of messages posted to a private channel.
-
#groups_setPurpose(options = {}) ⇒ Object
Sets the purpose for a private channel.
-
#groups_setTopic(options = {}) ⇒ Object
Sets the topic for a private channel.
-
#groups_unarchive(options = {}) ⇒ Object
Unarchives a private channel.
Instance Method Details
#groups_archive(options = {}) ⇒ Object
Archives a private channel.
15 16 17 18 19 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 15 def groups_archive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.archive', ) end |
#groups_close(options = {}) ⇒ Object
Closes a private channel.
28 29 30 31 32 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 28 def groups_close( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.close', ) end |
#groups_create(options = {}) ⇒ Object
Creates a private channel.
43 44 45 46 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 43 def groups_create( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('groups.create', ) end |
#groups_createChild(options = {}) ⇒ Object
Clones and archives a private channel.
55 56 57 58 59 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 55 def groups_createChild( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.createChild', ) end |
#groups_history(options = {}) ⇒ Object
Fetches history of messages and events from a private channel.
76 77 78 79 80 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 76 def groups_history( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.history', ) end |
#groups_info(options = {}) ⇒ Object
Gets information about a private channel.
89 90 91 92 93 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 89 def groups_info( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.info', ) end |
#groups_invite(options = {}) ⇒ Object
Invites a user to a private channel.
104 105 106 107 108 109 110 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 104 def groups_invite( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :user missing') if [:user].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] = .merge(user: users_id()['user']['id']) if [:user] post('groups.invite', ) end |
#groups_kick(options = {}) ⇒ Object
Removes a user from a private channel.
121 122 123 124 125 126 127 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 121 def groups_kick( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :user missing') if [:user].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] = .merge(user: users_id()['user']['id']) if [:user] post('groups.kick', ) end |
#groups_leave(options = {}) ⇒ Object
Leaves a private channel.
136 137 138 139 140 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 136 def groups_leave( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.leave', ) end |
#groups_list(options = {}) ⇒ Object
Lists private channels that the calling user has access to.
151 152 153 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 151 def groups_list( = {}) post('groups.list', ) end |
#groups_mark(options = {}) ⇒ Object
Sets the read cursor in a private channel.
164 165 166 167 168 169 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 164 def groups_mark( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :ts missing') if [:ts].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.mark', ) end |
#groups_open(options = {}) ⇒ Object
Opens a private channel.
178 179 180 181 182 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 178 def groups_open( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.open', ) end |
#groups_rename(options = {}) ⇒ Object
Renames a private channel.
195 196 197 198 199 200 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 195 def groups_rename( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :name missing') if [:name].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.rename', ) end |
#groups_replies(options = {}) ⇒ Object
Retrieve a thread of messages posted to a private channel
211 212 213 214 215 216 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 211 def groups_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: groups_id()['group']['id']) if [:channel] post('groups.replies', ) end |
#groups_setPurpose(options = {}) ⇒ Object
Sets the purpose for a private channel.
227 228 229 230 231 232 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 227 def groups_setPurpose( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :purpose missing') if [:purpose].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.setPurpose', ) end |
#groups_setTopic(options = {}) ⇒ Object
Sets the topic for a private channel.
243 244 245 246 247 248 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 243 def groups_setTopic( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :topic missing') if [:topic].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.setTopic', ) end |
#groups_unarchive(options = {}) ⇒ Object
Unarchives a private channel.
257 258 259 260 261 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 257 def groups_unarchive( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: groups_id()['group']['id']) if [:channel] post('groups.unarchive', ) end |