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
This method archives a private channel.
-
#groups_close(options = {}) ⇒ Object
This method closes a private channel.
-
#groups_create(options = {}) ⇒ Object
This method creates a private channel.
-
#groups_createChild(options = {}) ⇒ Object
This method takes an existing private channel and performs the following steps:.
-
#groups_history(options = {}) ⇒ Object
This method returns a portion of messages/events from the specified private channel.
-
#groups_info(options = {}) ⇒ Object
This method returns information about a private channel.
-
#groups_invite(options = {}) ⇒ Object
This method is used to invite a user to a private channel.
-
#groups_kick(options = {}) ⇒ Object
This method allows a user to remove another member from a private channel.
-
#groups_leave(options = {}) ⇒ Object
This method is used to leave a private channel.
-
#groups_list(options = {}) ⇒ Object
This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in.
-
#groups_mark(options = {}) ⇒ Object
This method moves the read cursor in a private channel.
-
#groups_open(options = {}) ⇒ Object
This method opens a private channel.
-
#groups_rename(options = {}) ⇒ Object
This method renames a private channel.
-
#groups_setPurpose(options = {}) ⇒ Object
This method is used to change the purpose of a private channel.
-
#groups_setTopic(options = {}) ⇒ Object
This method is used to change the topic of a private channel.
-
#groups_unarchive(options = {}) ⇒ Object
This method unarchives a private channel.
Instance Method Details
#groups_archive(options = {}) ⇒ Object
This method 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
This method 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
This method creates a private channel.
41 42 43 44 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 41 def groups_create( = {}) throw ArgumentError.new('Required arguments :name missing') if [:name].nil? post('groups.create', ) end |
#groups_createChild(options = {}) ⇒ Object
This method takes an existing private channel and performs the following steps:
53 54 55 56 57 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 53 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
This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.
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
This method returns 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
This method is used to invite a user to a private channel. The calling user must be a member of the 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
This method allows a user to remove another member 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
This method is used to leave 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
This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each private channel is also returned.
150 151 152 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 150 def groups_list( = {}) post('groups.list', ) end |
#groups_mark(options = {}) ⇒ Object
This method moves the read cursor in a private channel.
163 164 165 166 167 168 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 163 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
This method opens a private channel.
177 178 179 180 181 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 177 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
This method renames a private channel.
192 193 194 195 196 197 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 192 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_setPurpose(options = {}) ⇒ Object
This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
208 209 210 211 212 213 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 208 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
This method is used to change the topic of a private channel. The calling user must be a member of the private channel.
224 225 226 227 228 229 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 224 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
This method unarchives a private channel.
238 239 240 241 242 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 238 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 |