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_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
Don’t use this method.
-
#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
Don’t use this method.
-
#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_replies(options = {}) ⇒ Object
This method returns an entire thread (a message plus all the messages in reply to it).
-
#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_create(options = {}) ⇒ Object
This method creates a private channel.
30 31 32 33 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 30 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:
42 43 44 45 46 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 42 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.
65 66 67 68 69 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 65 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
Don’t use this method. Use conversations.info instead.
80 81 82 83 84 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 80 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.
95 96 97 98 99 100 101 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 95 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.
112 113 114 115 116 117 118 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 112 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.
127 128 129 130 131 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 127 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
Don’t use this method. Use conversations.list instead.
146 147 148 149 150 151 152 153 154 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 146 def groups_list( = {}) if block_given? Pagination::Cursor.new(self, :groups_list, ).each do |page| yield page end else post('groups.list', ) end end |
#groups_mark(options = {}) ⇒ Object
This method moves the read cursor in a private channel.
165 166 167 168 169 170 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 165 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.
179 180 181 182 183 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 179 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.
196 197 198 199 200 201 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 196 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
This method returns an entire thread (a message plus all the messages in reply to it).
212 213 214 215 216 217 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 212 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
This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
228 229 230 231 232 233 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 228 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.
244 245 246 247 248 249 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 244 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.
258 259 260 261 262 |
# File 'lib/slack/web/api/endpoints/groups.rb', line 258 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 |