Module: Discordrb::API::Channel

Defined in:
lib/discordrb/api/channel.rb

Overview

API calls for Channel

Class Method Summary collapse

Class Method Details

.add_group_user(token, group_channel_id, user_id) ⇒ Object

Add a user to a group channel.



366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/discordrb/api/channel.rb', line 366

def add_group_user(token, group_channel_id, user_id)
  Discordrb::API.request(
    :channels_cid_recipients_uid,
    nil,
    :put,
    "#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
    {}.to_json,
    Authorization: token,
    content_type: :json
  )
end

.bulk_delete_messages(token, channel_id, messages = [], reason = nil) ⇒ Object

Delete messages in bulk https://discordapp.com/developers/docs/resources/channel#bulk-delete-messages



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/discordrb/api/channel.rb', line 146

def bulk_delete_messages(token, channel_id, messages = [], reason = nil)
  Discordrb::API.request(
    :channels_cid_messages_bulk_delete,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/bulk-delete",
    { messages: messages }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.create_empty_group(token, bot_user_id) ⇒ Object

Create an empty group channel.



334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/discordrb/api/channel.rb', line 334

def create_empty_group(token, bot_user_id)
  Discordrb::API.request(
    :users_uid_channels,
    nil,
    :post,
    "#{Discordrb::API.api_base}/users/#{bot_user_id}/channels",
    {}.to_json,
    Authorization: token,
    content_type: :json
  )
end

.create_group(token, pm_channel_id, user_id) ⇒ Object

Create a group channel.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/discordrb/api/channel.rb', line 347

def create_group(token, pm_channel_id, user_id)
  Discordrb::API.request(
    :channels_cid_recipients_uid,
    nil,
    :put,
    "#{Discordrb::API.api_base}/channels/#{pm_channel_id}/recipients/#{user_id}",
    {}.to_json,
    Authorization: token,
    content_type: :json
  )
rescue RestClient::InternalServerError
  raise 'Attempted to add self as a new group channel recipient!'
rescue RestClient::NoContent
  raise 'Attempted to create a group channel with the PM channel recipient!'
rescue RestClient::Forbidden
  raise 'Attempted to add a user to group channel without permission!'
end

.create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil) ⇒ Object

Create an instant invite from a server or a channel id https://discord.com/developers/docs/resources/channel#create-channel-invite



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/discordrb/api/channel.rb', line 255

def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil)
  Discordrb::API.request(
    :channels_cid_invites,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
    { max_age: max_age, max_uses: max_uses, temporary: temporary, unique: unique }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.create_message(token, channel_id, message, tts = false, embed = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil) ⇒ Object

Send a message to a channel https://discordapp.com/developers/docs/resources/channel#create-message

Parameters:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/discordrb/api/channel.rb', line 77

def create_message(token, channel_id, message, tts = false, embed = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
  body = { content: message, tts: tts, embed: embed, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference }
  body = if attachments
           files = [*0...attachments.size].zip(attachments).to_h
           { **files, payload_json: body.to_json }
         else
           body.to_json
         end

  headers = { Authorization: token }
  headers[:content_type] = :json unless attachments

  Discordrb::API.request(
    :channels_cid_messages_mid,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
    body,
    **headers
  )
rescue RestClient::BadRequest => e
  parsed = JSON.parse(e.response.body)
  raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or fewer in length.'

  raise
end

.create_reaction(token, channel_id, message_id, emoji) ⇒ Object

Create a reaction on a message using this client https://discord.com/developers/docs/resources/channel#create-reaction



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/discordrb/api/channel.rb', line 161

def create_reaction(token, channel_id, message_id, emoji)
  emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
  Discordrb::API.request(
    :channels_cid_messages_mid_reactions_emoji_me,
    channel_id,
    :put,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me",
    nil,
    Authorization: token,
    content_type: :json
  )
end

.create_webhook(token, channel_id, name, avatar = nil, reason = nil) ⇒ Object

Create a webhook https://discord.com/developers/docs/resources/webhook#create-webhook



404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/discordrb/api/channel.rb', line 404

def create_webhook(token, channel_id, name, avatar = nil, reason = nil)
  Discordrb::API.request(
    :channels_cid_webhooks,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
    { name: name, avatar: avatar }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.delete(token, channel_id, reason = nil) ⇒ Object

Delete a channel https://discord.com/developers/docs/resources/channel#deleteclose-channel



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/discordrb/api/channel.rb', line 38

def delete(token, channel_id, reason = nil)
  Discordrb::API.request(
    :channels_cid,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}",
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end

.delete_all_reactions(token, channel_id, message_id) ⇒ Object

Deletes all reactions on a message from all clients https://discord.com/developers/docs/resources/channel#delete-all-reactions



216
217
218
219
220
221
222
223
224
 
# File 'lib/discordrb/api/channel.rb', line 216

def delete_all_reactions(token, channel_id, message_id)
  Discordrb::API.request(
    :channels_cid_messages_mid_reactions,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions",
    Authorization: token
  )
end

.delete_message(token, channel_id, message_id, reason = nil) ⇒ Object

Delete a message https://discordapp.com/developers/docs/resources/channel#delete-message



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/discordrb/api/channel.rb', line 133

def delete_message(token, channel_id, message_id, reason = nil)
  Discordrb::API.request(
    :channels_cid_messages_mid,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end

.delete_own_reaction(token, channel_id, message_id, emoji) ⇒ Object

Delete this client's own reaction on a message https://discord.com/developers/docs/resources/channel#delete-own-reaction



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/discordrb/api/channel.rb', line 176

def delete_own_reaction(token, channel_id, message_id, emoji)
  emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
  Discordrb::API.request(
    :channels_cid_messages_mid_reactions_emoji_me,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me",
    Authorization: token
  )
end

.delete_permission(token, channel_id, overwrite_id, reason = nil) ⇒ Object

Delete channel permission https://discord.com/developers/docs/resources/channel#delete-channel-permission



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/discordrb/api/channel.rb', line 270

def delete_permission(token, channel_id, overwrite_id, reason = nil)
  Discordrb::API.request(
    :channels_cid_permissions_oid,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end

.delete_user_reaction(token, channel_id, message_id, emoji, user_id) ⇒ Object

Delete another client's reaction on a message https://discord.com/developers/docs/resources/channel#delete-user-reaction



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/discordrb/api/channel.rb', line 189

def delete_user_reaction(token, channel_id, message_id, emoji, user_id)
  emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
  Discordrb::API.request(
    :channels_cid_messages_mid_reactions_emoji_uid,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/#{user_id}",
    Authorization: token
  )
end

.edit_message(token, channel_id, message_id, message, mentions = [], embed = nil) ⇒ Object

Edit a message https://discord.com/developers/docs/resources/channel#edit-message



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/discordrb/api/channel.rb', line 119

def edit_message(token, channel_id, message_id, message, mentions = [], embed = nil)
  Discordrb::API.request(
    :channels_cid_messages_mid,
    channel_id,
    :patch,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
    { content: message, mentions: mentions, embed: embed }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.get_reactions(token, channel_id, message_id, emoji, before_id, after_id, limit = 100) ⇒ Object

Get a list of clients who reacted with a specific reaction on a message https://discord.com/developers/docs/resources/channel#get-reactions



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/discordrb/api/channel.rb', line 202

def get_reactions(token, channel_id, message_id, emoji, before_id, after_id, limit = 100)
  emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
  query_string = "limit=#{limit}#{"&before=#{before_id}" if before_id}#{"&after=#{after_id}" if after_id}"
  Discordrb::API.request(
    :channels_cid_messages_mid_reactions_emoji,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}?#{query_string}",
    Authorization: token
  )
end

.invites(token, channel_id) ⇒ Object

Get a channel's invite list https://discord.com/developers/docs/resources/channel#get-channel-invites



243
244
245
246
247
248
249
250
251
 
# File 'lib/discordrb/api/channel.rb', line 243

def invites(token, channel_id)
  Discordrb::API.request(
    :channels_cid_invites,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
    Authorization: token
  )
end

.leave_group(token, group_channel_id) ⇒ Object

Leave a group channel.



391
392
393
394
395
396
397
398
399
400
 
# File 'lib/discordrb/api/channel.rb', line 391

def leave_group(token, group_channel_id)
  Discordrb::API.request(
    :channels_cid,
    nil,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{group_channel_id}",
    Authorization: token,
    content_type: :json
  )
end

.message(token, channel_id, message_id) ⇒ Object

Get a single message from a channel's history by id https://discord.com/developers/docs/resources/channel#get-channel-message



63
64
65
66
67
68
69
70
71
 
# File 'lib/discordrb/api/channel.rb', line 63

def message(token, channel_id, message_id)
  Discordrb::API.request(
    :channels_cid_messages_mid,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
    Authorization: token
  )
end

.messages(token, channel_id, amount, before = nil, after = nil, around = nil) ⇒ Object

Get a list of messages from a channel's history https://discord.com/developers/docs/resources/channel#get-channel-messages



51
52
53
54
55
56
57
58
59
 
# File 'lib/discordrb/api/channel.rb', line 51

def messages(token, channel_id, amount, before = nil, after = nil, around = nil)
  Discordrb::API.request(
    :channels_cid_messages,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}#{"&around=#{around}" if around}",
    Authorization: token
  )
end

.pin_message(token, channel_id, message_id, reason = nil) ⇒ Object

Pin a message https://discordapp.com/developers/docs/resources/channel#add-pinned-channel-message



308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/discordrb/api/channel.rb', line 308

def pin_message(token, channel_id, message_id, reason = nil)
  Discordrb::API.request(
    :channels_cid_pins_mid,
    channel_id,
    :put,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
    nil,
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end

.pinned_messages(token, channel_id) ⇒ Object

Get a list of pinned messages in a channel https://discord.com/developers/docs/resources/channel#get-pinned-messages



296
297
298
299
300
301
302
303
304
 
# File 'lib/discordrb/api/channel.rb', line 296

def pinned_messages(token, channel_id)
  Discordrb::API.request(
    :channels_cid_pins,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/pins",
    Authorization: token
  )
end

.remove_group_user(token, group_channel_id, user_id) ⇒ Object

Remove a user from a group channel.



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/discordrb/api/channel.rb', line 379

def remove_group_user(token, group_channel_id, user_id)
  Discordrb::API.request(
    :channels_cid_recipients_uid,
    nil,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
    Authorization: token,
    content_type: :json
  )
end

.resolve(token, channel_id) ⇒ Object

Get a channel's data https://discord.com/developers/docs/resources/channel#get-channel



9
10
11
12
13
14
15
16
17
 
# File 'lib/discordrb/api/channel.rb', line 9

def resolve(token, channel_id)
  Discordrb::API.request(
    :channels_cid,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}",
    Authorization: token
  )
end

.start_typing(token, channel_id) ⇒ Object

Start typing (needs to be resent every 5 seconds to keep up the typing) https://discord.com/developers/docs/resources/channel#trigger-typing-indicator



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/discordrb/api/channel.rb', line 283

def start_typing(token, channel_id)
  Discordrb::API.request(
    :channels_cid_typing,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/typing",
    nil,
    Authorization: token
  )
end

.unpin_message(token, channel_id, message_id, reason = nil) ⇒ Object

Unpin a message https://discordapp.com/developers/docs/resources/channel#delete-pinned-channel-message



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/discordrb/api/channel.rb', line 322

def unpin_message(token, channel_id, message_id, reason = nil)
  Discordrb::API.request(
    :channels_cid_pins_mid,
    channel_id,
    :delete,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end

.update(token, channel_id, name, topic, position, bitrate, user_limit, nsfw, permission_overwrites = nil, parent_id = nil, rate_limit_per_user = nil, reason = nil) ⇒ Object

Update a channel's data https://discord.com/developers/docs/resources/channel#modify-channel



21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/discordrb/api/channel.rb', line 21

def update(token, channel_id, name, topic, position, bitrate, user_limit, nsfw, permission_overwrites = nil, parent_id = nil, rate_limit_per_user = nil, reason = nil)
  data = { name: name, position: position, topic: topic, bitrate: bitrate, user_limit: user_limit, nsfw: nsfw, parent_id: parent_id, rate_limit_per_user: rate_limit_per_user }
  data[:permission_overwrites] = permission_overwrites unless permission_overwrites.nil?
  Discordrb::API.request(
    :channels_cid,
    channel_id,
    :patch,
    "#{Discordrb::API.api_base}/channels/#{channel_id}",
    data.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.update_permission(token, channel_id, overwrite_id, allow, deny, type, reason = nil) ⇒ Object

Update a channels permission for a role or member https://discord.com/developers/docs/resources/channel#edit-channel-permissions



228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/discordrb/api/channel.rb', line 228

def update_permission(token, channel_id, overwrite_id, allow, deny, type, reason = nil)
  Discordrb::API.request(
    :channels_cid_permissions_oid,
    channel_id,
    :put,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
    { type: type, id: overwrite_id, allow: allow, deny: deny }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.upload_file(token, channel_id, file, caption: nil, tts: false) ⇒ Object

Send a file as a message to a channel https://discord.com/developers/docs/resources/channel#upload-file



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/discordrb/api/channel.rb', line 106

def upload_file(token, channel_id, file, caption: nil, tts: false)
  Discordrb::API.request(
    :channels_cid_messages_mid,
    channel_id,
    :post,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
    { file: file, content: caption, tts: tts },
    Authorization: token
  )
end

.webhooks(token, channel_id) ⇒ Object

Get channel webhooks https://discord.com/developers/docs/resources/webhook#get-channel-webhooks



419
420
421
422
423
424
425
426
427
 
# File 'lib/discordrb/api/channel.rb', line 419

def webhooks(token, channel_id)
  Discordrb::API.request(
    :channels_cid_webhooks,
    channel_id,
    :get,
    "#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
    Authorization: token
  )
end