module Discordrb::API::Channel
Public Instance Methods
Add a user to a group channel. @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here. discord.com/developers/docs/resources/channel#group-dm-add-recipient
# File lib/discordrb/api/channel.rb, line 387 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
Add a user to a thread. discord.com/developers/docs/resources/channel#add-thread-member
# File lib/discordrb/api/channel.rb, line 497 def add_thread_member(token, channel_id, user_id) Discordrb::API.request( :channels_cid_thread_members_uid, channel_id, :put, "#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}", nil, Authorization: token ) end
Delete messages in bulk discord.com/developers/docs/resources/channel#bulk-delete-messages
# File lib/discordrb/api/channel.rb, line 147 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 an empty group channel. @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here. discord.com/developers/docs/resources/user#create-group-dm
# File lib/discordrb/api/channel.rb, line 351 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 a group channel. @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here. discord.com/developers/docs/resources/channel#group-dm-add-recipient
# File lib/discordrb/api/channel.rb, line 366 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 an instant invite from a server or a channel id discord.com/developers/docs/resources/channel#create-channel-invite
# File lib/discordrb/api/channel.rb, line 270 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
Send a message to a channel discord.com/developers/docs/resources/channel#create-message @param attachments [Array<File>, nil] Attachments to use with ‘attachment://` in embeds. See
https://discord.com/developers/docs/resources/channel#create-message-using-attachments-within-embeds
# File lib/discordrb/api/channel.rb, line 78 def create_message(token, channel_id, message, tts = false, embeds = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) body = { content: message, tts: tts, embeds: embeds, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference, components: components&.to_a } 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 a reaction on a message using this client discord.com/developers/docs/resources/channel#create-reaction
# File lib/discordrb/api/channel.rb, line 162 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 a webhook discord.com/developers/docs/resources/webhook#create-webhook
# File lib/discordrb/api/channel.rb, line 429 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 a channel discord.com/developers/docs/resources/channel#deleteclose-channel
# 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
Deletes all the reactions for a given emoji on a message discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji
# File lib/discordrb/api/channel.rb, line 229 def delete_all_emoji_reactions(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, channel_id, :delete, "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}", Authorization: token ) end
Deletes all reactions on a message from all clients discord.com/developers/docs/resources/channel#delete-all-reactions
# File lib/discordrb/api/channel.rb, line 217 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 a message discord.com/developers/docs/resources/channel#delete-message
# File lib/discordrb/api/channel.rb, line 134 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 this client’s own reaction on a message discord.com/developers/docs/resources/channel#delete-own-reaction
# File lib/discordrb/api/channel.rb, line 177 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 channel permission discord.com/developers/docs/resources/channel#delete-channel-permission
# File lib/discordrb/api/channel.rb, line 285 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 another client’s reaction on a message discord.com/developers/docs/resources/channel#delete-user-reaction
# File lib/discordrb/api/channel.rb, line 190 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 a message discord.com/developers/docs/resources/channel#edit-message
# File lib/discordrb/api/channel.rb, line 120 def edit_message(token, channel_id, message_id, message, mentions = [], embeds = nil, components = 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, embeds: embeds, components: components }.to_json, Authorization: token, content_type: :json ) end
Get a list of clients who reacted with a specific reaction on a message discord.com/developers/docs/resources/channel#get-reactions
# File lib/discordrb/api/channel.rb, line 203 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 = URI.encode_www_form({ limit: limit || 100, before: before_id, after: after_id }.compact) 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
Get a channel’s invite list discord.com/developers/docs/resources/channel#get-channel-invites
# File lib/discordrb/api/channel.rb, line 258 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
Add the current user to a thread. discord.com/developers/docs/resources/channel#join-thread
# File lib/discordrb/api/channel.rb, line 484 def join_thread(token, channel_id) Discordrb::API.request( :channels_cid_thread_members_me, channel_id, :put, "#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/@me", nil, Authorization: token ) end
Leave a group channel. @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here. discord.com/developers/docs/resources/channel#deleteclose-channel
# File lib/discordrb/api/channel.rb, line 416 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
Remove the current user from a thread. discord.com/developers/docs/resources/channel#leave-thread
# File lib/discordrb/api/channel.rb, line 510 def leave_thread(token, channel_id) Discordrb::API.request( :channels_cid_thread_members_me, channel_id, :delete, "#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}", Authorization: token ) end
List active threads discord.com/developers/docs/resources/channel#list-active-threads
# File lib/discordrb/api/channel.rb, line 548 def list_active_threads(token, channel_id) Discordrb::API.request( :channels_cid_threads_active, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/threads/active", Authorization: token ) end
List joined private archived threads. discord.com/developers/docs/resources/channel#list-joined-private-archived-threads
# File lib/discordrb/api/channel.rb, line 588 def list_joined_private_archived_threads(token, channel_id, before = nil, limit = nil) query = URI.encode_www_form({ before: before, limit: limit }.compact) Discordrb::API.request( :channels_cid_users_me_threads_archived_private, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/users/@me/threads/archived/private?#{query}", Authorization: token ) end
List private archived threads. discord.com/developers/docs/resources/channel#list-private-archived-threads
# File lib/discordrb/api/channel.rb, line 574 def list_private_archived_threads(token, channel_id, before = nil, limit = nil) query = URI.encode_www_form({ before: before, limit: limit }.compact) Discordrb::API.request( :channels_cid_threads_archived_private, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/threads/archived/private?#{query}", Authorization: token ) end
List public archived threads. discord.com/developers/docs/resources/channel#list-public-archived-threads
# File lib/discordrb/api/channel.rb, line 560 def list_public_archived_threads(token, channel_id, before = nil, limit = nil) query = URI.encode_www_form({ before: before, limit: limit }.compact) Discordrb::API.request( :channels_cid_threads_archived_public, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/threads/archived/public?#{query}", Authorization: token ) end
Get the members of a thread. discord.com/developers/docs/resources/channel#list-thread-members
# File lib/discordrb/api/channel.rb, line 534 def list_thread_members(token, channel_id, before, limit) query = URI.encode_www_form({ before: before, limit: limit }.compact) Discordrb::API.request( :channels_cid_thread_members, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members?#{query}", Authorization: token ) end
Get a single message from a channel’s history by id discord.com/developers/docs/resources/channel#get-channel-message
# File lib/discordrb/api/channel.rb, line 64 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
Get a list of messages from a channel’s history discord.com/developers/docs/resources/channel#get-channel-messages
# File lib/discordrb/api/channel.rb, line 51 def messages(token, channel_id, amount, before = nil, after = nil, around = nil) query_string = URI.encode_www_form({ limit: amount, before: before, after: after, around: around }.compact) Discordrb::API.request( :channels_cid_messages, channel_id, :get, "#{Discordrb::API.api_base}/channels/#{channel_id}/messages?#{query_string}", Authorization: token ) end
Pin a message discord.com/developers/docs/resources/channel#add-pinned-channel-message
# File lib/discordrb/api/channel.rb, line 323 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
Get a list of pinned messages in a channel discord.com/developers/docs/resources/channel#get-pinned-messages
# File lib/discordrb/api/channel.rb, line 311 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 a user from a group channel. @deprecated Discord no longer supports bots in group DMs, this endpoint was repurposed and no longer works as implemented here. discord.com/developers/docs/resources/channel#group-dm-remove-recipient
# File lib/discordrb/api/channel.rb, line 402 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
Remove a user from a thread. discord.com/developers/docs/resources/channel#remove-thread-member
# File lib/discordrb/api/channel.rb, line 522 def remove_thread_member(token, channel_id, user_id) Discordrb::API.request( :channels_cid_thread_members_uid, channel_id, :delete, "#{Discordrb::API.api_base}/channels/#{channel_id}/thread-members/#{user_id}", Authorization: token ) end
Get a channel’s data discord.com/developers/docs/resources/channel#get-channel
# 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 a thread based off a channel message. discord.com/developers/docs/resources/channel#start-thread-with-message
# File lib/discordrb/api/channel.rb, line 456 def start_thread_with_message(token, channel_id, message_id, name, auto_archive_duration) Discordrb::API.request( :channels_cid_messages_mid_threads, channel_id, :post, "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/threads", { name: name, auto_archive_duration: auto_archive_duration }.to_json, Authorization: token, content_type: :json ) end
Start a thread without an associated message. discord.com/developers/docs/resources/channel#start-thread-without-message
# File lib/discordrb/api/channel.rb, line 470 def start_thread_without_message(token, channel_id, name, auto_archive_duration, type = 11) Discordrb::API.request( :channels_cid_threads, channel_id, :post, "#{Discordrb::API.api_base}/channels/#{channel_id}/threads", { name: name, auto_archive_duration: auto_archive_duration, type: type }, Authorization: token, content_type: :json ) end
Start typing (needs to be resent every 5 seconds to keep up the typing) discord.com/developers/docs/resources/channel#trigger-typing-indicator
# File lib/discordrb/api/channel.rb, line 298 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 a message discord.com/developers/docs/resources/channel#delete-pinned-channel-message
# File lib/discordrb/api/channel.rb, line 337 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 a channel’s data discord.com/developers/docs/resources/channel#modify-channel
# 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 a channels permission for a role or member discord.com/developers/docs/resources/channel#edit-channel-permissions
# File lib/discordrb/api/channel.rb, line 243 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
Send a file as a message to a channel discord.com/developers/docs/resources/channel#upload-file
# File lib/discordrb/api/channel.rb, line 107 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
Get channel webhooks discord.com/developers/docs/resources/webhook#get-channel-webhooks
# File lib/discordrb/api/channel.rb, line 444 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