module Discordrb::API::Server
Public Instance Methods
Adds a custom emoji
# File lib/discordrb/api/server.rb, line 456 def add_emoji(token, server_id, image, name, reason = nil) Discordrb::API.request( :guilds_sid_emojis, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis", { image: image, name: name }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Adds a member to a server with an OAuth2 Bearer token that has been granted `guilds.join` discordapp.com/developers/docs/resources/guild#add-guild-member
# File lib/discordrb/api/server.rb, line 520 def add_member(token, server_id, user_id, access_token, nick = nil, roles = [], mute = false, deaf = false) Discordrb::API.request( :guilds_sid_members_uid, server_id, :put, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", { access_token: access_token, nick: nick, roles: roles, mute: mute, deaf: deaf }.to_json, content_type: :json, Authorization: token ) end
Adds a single role to a member discordapp.com/developers/docs/resources/guild#add-guild-member-role
# File lib/discordrb/api/server.rb, line 289 def add_member_role(token, server_id, user_id, role_id, reason = nil) Discordrb::API.request( :guilds_sid_members_uid_roles_rid, server_id, :put, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}", nil, Authorization: token, 'X-Audit-Log-Reason': reason ) end
Gets a server's audit logs discordapp.com/developers/docs/resources/audit-log#get-guild-audit-log
# File lib/discordrb/api/server.rb, line 354 def audit_logs(token, server_id, limit, userid = nil, actiontype = nil, before = nil) Discordrb::API.request( :guilds_sid_auditlogs, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/audit-logs?limit=#{limit}#{"&user_id=#{userid}" if userid}#{"&action_type=#{actiontype}" if actiontype}#{"&before=#{before}" if before}", Authorization: token ) end
Ban a user from a server and delete their messages from the last message_days days discordapp.com/developers/docs/resources/guild#create-guild-ban
# File lib/discordrb/api/server.rb, line 187 def ban_user(token, server_id, user_id, message_days, reason = nil) reason = URI.encode_www_form_component(reason) if reason Discordrb::API.request( :guilds_sid_bans_uid, server_id, :put, "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}&reason=#{reason}", nil, Authorization: token ) end
Get a server's banned users discordapp.com/developers/docs/resources/guild#get-guild-bans
# File lib/discordrb/api/server.rb, line 175 def bans(token, server_id) Discordrb::API.request( :guilds_sid_bans, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/bans", Authorization: token ) end
Begin server prune discordapp.com/developers/docs/resources/guild#begin-guild-prune
# File lib/discordrb/api/server.rb, line 328 def begin_prune(token, server_id, days, reason = nil) Discordrb::API.request( :guilds_sid_prune, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/prune", { days: days }, Authorization: token, 'X-Audit-Log-Reason': reason ) end
Get a server's channels list discordapp.com/developers/docs/resources/guild#get-guild-channels
# File lib/discordrb/api/server.rb, line 76 def channels(token, server_id) Discordrb::API.request( :guilds_sid_channels, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/channels", Authorization: token ) end
Create a server discordapp.com/developers/docs/resources/guild#create-guild
# File lib/discordrb/api/server.rb, line 9 def create(token, name, region = :'eu-central') Discordrb::API.request( :guilds, nil, :post, "#{Discordrb::API.api_base}/guilds", { name: name, region: region.to_s }.to_json, Authorization: token, content_type: :json ) end
Create a channel discordapp.com/developers/docs/resources/guild#create-guild-channel
# File lib/discordrb/api/server.rb, line 88 def create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, reason = nil) Discordrb::API.request( :guilds_sid_channels, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/channels", { name: name, type: type, topic: topic, bitrate: bitrate, user_limit: user_limit, permission_overwrites: permission_overwrites, parent_id: parent_id, nsfw: nsfw, rate_limit_per_user: rate_limit_per_user }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Create a server integration discordapp.com/developers/docs/resources/guild#create-guild-integration
# File lib/discordrb/api/server.rb, line 378 def create_integration(token, server_id, type, id) Discordrb::API.request( :guilds_sid_integrations, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations", { type: type, id: id }, Authorization: token ) end
Create a role (parameters such as name and colour if not set can be set by update_role
afterwards) Permissions
are the Discord defaults; allowed: invite creation, reading/sending messages, sending TTS messages, embedding links, sending files, reading the history, mentioning everybody, connecting to voice, speaking and voice activity (push-to-talk isn't mandatory) discordapp.com/developers/docs/resources/guild#get-guild-roles
# File lib/discordrb/api/server.rb, line 229 def create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil) Discordrb::API.request( :guilds_sid_roles, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/roles", { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Delete a server discordapp.com/developers/docs/resources/guild#delete-guild
# File lib/discordrb/api/server.rb, line 64 def delete(token, server_id) Discordrb::API.request( :guilds_sid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}", Authorization: token ) end
Deletes a custom emoji
# File lib/discordrb/api/server.rb, line 484 def delete_emoji(token, server_id, emoji_id, reason = nil) Discordrb::API.request( :guilds_sid_emojis_eid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}", Authorization: token, 'X-Audit-Log-Reason': reason ) end
Delete a server integration discordapp.com/developers/docs/resources/guild#delete-guild-integration
# File lib/discordrb/api/server.rb, line 405 def delete_integration(token, server_id, integration_id) Discordrb::API.request( :guilds_sid_integrations_iid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}", Authorization: token ) end
Delete a role discordapp.com/developers/docs/resources/guild#delete-guild-role
# File lib/discordrb/api/server.rb, line 276 def delete_role(token, server_id, role_id, reason = nil) Discordrb::API.request( :guilds_sid_roles_rid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}", Authorization: token, 'X-Audit-Log-Reason': reason ) end
Changes an emoji name
# File lib/discordrb/api/server.rb, line 470 def edit_emoji(token, server_id, emoji_id, name, reason = nil) Discordrb::API.request( :guilds_sid_emojis_eid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}", { name: name }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Retrieves a server's embed information discordapp.com/developers/docs/resources/guild#get-guild-embed
# File lib/discordrb/api/server.rb, line 430 def embed(token, server_id) Discordrb::API.request( :guilds_sid_embed, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/embed", Authorization: token ) end
Get server integrations discordapp.com/developers/docs/resources/guild#get-guild-integrations
# File lib/discordrb/api/server.rb, line 366 def integrations(token, server_id) Discordrb::API.request( :guilds_sid_integrations, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations", Authorization: token ) end
Get invites from server discordapp.com/developers/docs/resources/guild#get-guild-invites
# File lib/discordrb/api/server.rb, line 342 def invites(token, server_id) Discordrb::API.request( :guilds_sid_invites, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/invites", Authorization: token ) end
Modify a server's embed settings discordapp.com/developers/docs/resources/guild#modify-guild-embed
# File lib/discordrb/api/server.rb, line 442 def modify_embed(token, server_id, enabled, channel_id, reason = nil) Discordrb::API.request( :guilds_sid_embed, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/embed", { enabled: enabled, channel_id: channel_id }.to_json, Authorization: token, 'X-Audit-Log-Reason': reason, content_type: :json ) end
Get server prune count discordapp.com/developers/docs/resources/guild#get-guild-prune-count
# File lib/discordrb/api/server.rb, line 316 def prune_count(token, server_id, days) Discordrb::API.request( :guilds_sid_prune, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/prune?days=#{days}", Authorization: token ) end
Available voice regions for this server
# File lib/discordrb/api/server.rb, line 496 def regions(token, server_id) Discordrb::API.request( :guilds_sid_regions, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/regions", Authorization: token ) end
Remove user from server discordapp.com/developers/docs/resources/guild#remove-guild-member
# File lib/discordrb/api/server.rb, line 161 def remove_member(token, server_id, user_id, reason = nil) Discordrb::API.request( :guilds_sid_members_uid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Removes a single role from a member discordapp.com/developers/docs/resources/guild#remove-guild-member-role
# File lib/discordrb/api/server.rb, line 303 def remove_member_role(token, server_id, user_id, role_id, reason = nil) Discordrb::API.request( :guilds_sid_members_uid_roles_rid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}", Authorization: token, 'X-Audit-Log-Reason': reason ) end
Get a server's data discordapp.com/developers/docs/resources/guild#get-guild
# File lib/discordrb/api/server.rb, line 23 def resolve(token, server_id) Discordrb::API.request( :guilds_sid, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}", Authorization: token ) end
Get a member's data discordapp.com/developers/docs/resources/guild#get-guild-member
# File lib/discordrb/api/server.rb, line 117 def resolve_member(token, server_id, user_id) Discordrb::API.request( :guilds_sid_members_uid, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", Authorization: token ) end
Gets members from the server discordapp.com/developers/docs/resources/guild#list-guild-members
# File lib/discordrb/api/server.rb, line 129 def resolve_members(token, server_id, limit, after = nil) Discordrb::API.request( :guilds_sid_members, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/members?limit=#{limit}#{"&after=#{after}" if after}", Authorization: token ) end
Get server roles discordapp.com/developers/docs/resources/guild#get-guild-roles
# File lib/discordrb/api/server.rb, line 214 def roles(token, server_id) Discordrb::API.request( :guilds_sid_roles, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/roles", Authorization: token ) end
Sync an integration discordapp.com/developers/docs/resources/guild#sync-guild-integration
# File lib/discordrb/api/server.rb, line 417 def sync_integration(token, server_id, integration_id) Discordrb::API.request( :guilds_sid_integrations_iid_sync, server_id, :post, "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}/sync", nil, Authorization: token ) end
Transfer server ownership
# File lib/discordrb/api/server.rb, line 49 def transfer_ownership(token, server_id, user_id, reason = nil) Discordrb::API.request( :guilds_sid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}", { owner_id: user_id }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Unban a user from a server discordapp.com/developers/docs/resources/guild#remove-guild-ban
# File lib/discordrb/api/server.rb, line 201 def unban_user(token, server_id, user_id, reason = nil) Discordrb::API.request( :guilds_sid_bans_uid, server_id, :delete, "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}", Authorization: token, 'X-Audit-Log-Reason': reason ) end
Update a server discordapp.com/developers/docs/resources/guild#modify-guild
# File lib/discordrb/api/server.rb, line 35 def update(token, server_id, name, region, icon, afk_channel_id, afk_timeout, splash, default_message_notifications, verification_level, explicit_content_filter, system_channel_id, reason = nil) Discordrb::API.request( :guilds_sid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}", { name: name, region: region, icon: icon, afk_channel_id: afk_channel_id, afk_timeout: afk_timeout, splash: splash, default_message_notifications: default_message_notifications, verification_level: verification_level, explicit_content_filter: explicit_content_filter, system_channel_id: system_channel_id }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Update a channels position discordapp.com/developers/docs/resources/guild#modify-guild-channel-positions
# File lib/discordrb/api/server.rb, line 103 def update_channel_positions(token, server_id, positions) Discordrb::API.request( :guilds_sid_channels, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/channels", positions.to_json, Authorization: token, content_type: :json ) end
Update integration from server discordapp.com/developers/docs/resources/guild#modify-guild-integration
# File lib/discordrb/api/server.rb, line 391 def update_integration(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons) Discordrb::API.request( :guilds_sid_integrations_iid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}", { expire_behavior: expire_behavior, expire_grace_period: expire_grace_period, enable_emoticons: enable_emoticons }.to_json, Authorization: token, content_type: :json ) end
Update a user properties discordapp.com/developers/docs/resources/guild#modify-guild-member
# File lib/discordrb/api/server.rb, line 141 def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil, reason: nil) Discordrb::API.request( :guilds_sid_members_uid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", { roles: roles, nick: nick, mute: mute, deaf: deaf, channel_id: channel_id }.reject { |_, v| v.nil? }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Update a role Permissions
are the Discord defaults; allowed: invite creation, reading/sending messages, sending TTS messages, embedding links, sending files, reading the history, mentioning everybody, connecting to voice, speaking and voice activity (push-to-talk isn't mandatory) discordapp.com/developers/docs/resources/guild#batch-modify-guild-role
# File lib/discordrb/api/server.rb, line 247 def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil) Discordrb::API.request( :guilds_sid_roles_rid, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}", { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json, Authorization: token, content_type: :json, 'X-Audit-Log-Reason': reason ) end
Update role positions discordapp.com/developers/docs/resources/guild#modify-guild-role-positions
# File lib/discordrb/api/server.rb, line 262 def update_role_positions(token, server_id, roles) Discordrb::API.request( :guilds_sid_roles, server_id, :patch, "#{Discordrb::API.api_base}/guilds/#{server_id}/roles", roles.to_json, Authorization: token, content_type: :json ) end
Get server webhooks discordapp.com/developers/docs/resources/webhook#get-guild-webhooks
# File lib/discordrb/api/server.rb, line 508 def webhooks(token, server_id) Discordrb::API.request( :guilds_sid_webhooks, server_id, :get, "#{Discordrb::API.api_base}/guilds/#{server_id}/webhooks", Authorization: token ) end