module Discordrb::API::Server

API calls for Server

Public Instance Methods

add_emoji(token, server_id, image, name, roles = [], reason = nil) click to toggle source

Adds a custom emoji. discord.com/developers/docs/resources/emoji#create-guild-emoji

# File lib/discordrb/api/server.rb, line 481
def add_emoji(token, server_id, image, name, roles = [], reason = nil)
  Discordrb::API.request(
    :guilds_sid_emojis,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis",
    { image: image, name: name, roles: roles }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
add_member(token, server_id, user_id, access_token, nick = nil, roles = [], mute = false, deaf = false) click to toggle source

Adds a member to a server with an OAuth2 Bearer token that has been granted ‘guilds.join` discord.com/developers/docs/resources/guild#add-guild-member

# File lib/discordrb/api/server.rb, line 548
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
add_member_role(token, server_id, user_id, role_id, reason = nil) click to toggle source

Adds a single role to a member discord.com/developers/docs/resources/guild#add-guild-member-role

# File lib/discordrb/api/server.rb, line 309
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
audit_logs(token, server_id, limit, user_id = nil, action_type = nil, before = nil) click to toggle source

Gets a server’s audit logs discord.com/developers/docs/resources/audit-log#get-guild-audit-log

# File lib/discordrb/api/server.rb, line 374
def audit_logs(token, server_id, limit, user_id = nil, action_type = 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=#{user_id}" if user_id}#{"&action_type=#{action_type}" if action_type}#{"&before=#{before}" if before}",
    Authorization: token
  )
end
ban_user(token, server_id, user_id, message_days, reason = nil) click to toggle source

Ban a user from a server and delete their messages from the last message_days days discord.com/developers/docs/resources/guild#create-guild-ban

# File lib/discordrb/api/server.rb, line 192
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
bans(token, server_id, limit = nil, before = nil, after = nil) click to toggle source

Get a server’s banned users discord.com/developers/docs/resources/guild#get-guild-bans

# File lib/discordrb/api/server.rb, line 179
def bans(token, server_id, limit = nil, before = nil, after = nil)
  query_string = URI.encode_www_form({ limit: limit, before: before, after: after }.compact)
  Discordrb::API.request(
    :guilds_sid_bans,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/bans?#{query_string}",
    Authorization: token
  )
end
begin_prune(token, server_id, days, reason = nil) click to toggle source

Begin server prune discord.com/developers/docs/resources/guild#begin-guild-prune

# File lib/discordrb/api/server.rb, line 348
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
channels(token, server_id) click to toggle source

Get a server’s channels list discord.com/developers/docs/resources/guild#get-guild-channels

# File lib/discordrb/api/server.rb, line 77
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(token, name, region = :'eu-central') click to toggle source

Create a server discord.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_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, position, reason = nil) click to toggle source

Create a channel discord.com/developers/docs/resources/guild#create-guild-channel

# File lib/discordrb/api/server.rb, line 89
def create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, position, 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, position: position }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
create_integration(token, server_id, type, id, reason = nil) click to toggle source

Create a server integration discord.com/developers/docs/resources/guild#create-guild-integration

# File lib/discordrb/api/server.rb, line 398
def create_integration(token, server_id, type, id, reason = nil)
  Discordrb::API.request(
    :guilds_sid_integrations,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
    { type: type, id: id },
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end
create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil) click to toggle source

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) discord.com/developers/docs/resources/guild#get-guild-roles

# File lib/discordrb/api/server.rb, line 234
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(token, server_id) click to toggle source

Delete a server discord.com/developers/docs/resources/guild#delete-guild

# File lib/discordrb/api/server.rb, line 65
def delete(token, server_id)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :delete,
    "#{Discordrb::API.api_base}/guilds/#{server_id}",
    Authorization: token
  )
end
delete_emoji(token, server_id, emoji_id, reason = nil) click to toggle source

Deletes a custom emoji discord.com/developers/docs/resources/emoji#delete-guild-emoji

# File lib/discordrb/api/server.rb, line 511
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_integration(token, server_id, integration_id, reason = nil) click to toggle source

Delete a server integration discord.com/developers/docs/resources/guild#delete-guild-integration

# File lib/discordrb/api/server.rb, line 426
def delete_integration(token, server_id, integration_id, reason = nil)
  Discordrb::API.request(
    :guilds_sid_integrations_iid,
    server_id,
    :delete,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
    Authorization: token,
    'X-Audit-Log-Reason': reason
  )
end
delete_role(token, server_id, role_id, reason = nil) click to toggle source

Delete a role discord.com/developers/docs/resources/guild#delete-guild-role

# File lib/discordrb/api/server.rb, line 296
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
edit_emoji(token, server_id, emoji_id, name, roles = nil, reason = nil) click to toggle source

Changes an emoji name and/or roles. discord.com/developers/docs/resources/emoji#modify-guild-emoji

# File lib/discordrb/api/server.rb, line 496
def edit_emoji(token, server_id, emoji_id, name, roles = nil, reason = nil)
  Discordrb::API.request(
    :guilds_sid_emojis_eid,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
    { name: name, roles: roles }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
embed(token, server_id)
Alias for: widget
integrations(token, server_id) click to toggle source

Get server integrations discord.com/developers/docs/resources/guild#get-guild-integrations

# File lib/discordrb/api/server.rb, line 386
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
invites(token, server_id) click to toggle source

Get invites from server discord.com/developers/docs/resources/guild#get-guild-invites

# File lib/discordrb/api/server.rb, line 362
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_embed(token, server_id, enabled, channel_id, reason = nil)
Alias for: modify_widget
modify_widget(token, server_id, enabled, channel_id, reason = nil) click to toggle source

Modify a server’s widget settings discord.com/developers/docs/resources/guild#modify-guild-widget

# File lib/discordrb/api/server.rb, line 465
def modify_widget(token, server_id, enabled, channel_id, reason = nil)
  Discordrb::API.request(
    :guilds_sid_embed,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/widget",
    { enabled: enabled, channel_id: channel_id }.to_json,
    Authorization: token,
    'X-Audit-Log-Reason': reason,
    content_type: :json
  )
end
Also aliased as: modify_embed
prune_count(token, server_id, days) click to toggle source

Get server prune count discord.com/developers/docs/resources/guild#get-guild-prune-count

# File lib/discordrb/api/server.rb, line 336
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
regions(token, server_id) click to toggle source

Available voice regions for this server discord.com/developers/docs/resources/guild#get-guild-voice-regions

# File lib/discordrb/api/server.rb, line 524
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_member(token, server_id, user_id, reason = nil) click to toggle source

Remove user from server discord.com/developers/docs/resources/guild#remove-guild-member

# File lib/discordrb/api/server.rb, line 165
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
remove_member_role(token, server_id, user_id, role_id, reason = nil) click to toggle source

Removes a single role from a member discord.com/developers/docs/resources/guild#remove-guild-member-role

# File lib/discordrb/api/server.rb, line 323
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
resolve(token, server_id, with_counts = nil) click to toggle source

Get a server’s data discord.com/developers/docs/resources/guild#get-guild

# File lib/discordrb/api/server.rb, line 23
def resolve(token, server_id, with_counts = nil)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}#{'?with_counts=true' if with_counts}",
    Authorization: token
  )
end
resolve_member(token, server_id, user_id) click to toggle source

Get a member’s data discord.com/developers/docs/resources/guild#get-guild-member

# File lib/discordrb/api/server.rb, line 118
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
resolve_members(token, server_id, limit, after = nil) click to toggle source

Gets members from the server discord.com/developers/docs/resources/guild#list-guild-members

# File lib/discordrb/api/server.rb, line 130
def resolve_members(token, server_id, limit, after = nil)
  query_string = URI.encode_www_form({ limit: limit, after: after }.compact)
  Discordrb::API.request(
    :guilds_sid_members,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/members?#{query_string}",
    Authorization: token
  )
end
roles(token, server_id) click to toggle source

Get server roles discord.com/developers/docs/resources/guild#get-guild-roles

# File lib/discordrb/api/server.rb, line 219
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_integration(token, server_id, integration_id) click to toggle source

Sync an integration discord.com/developers/docs/resources/guild#sync-guild-integration

# File lib/discordrb/api/server.rb, line 439
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_ownership(token, server_id, user_id, reason = nil) click to toggle source

Transfer server ownership discord.com/developers/docs/resources/guild#modify-guild

# File lib/discordrb/api/server.rb, line 50
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_user(token, server_id, user_id, reason = nil) click to toggle source

Unban a user from a server discord.com/developers/docs/resources/guild#remove-guild-ban

# File lib/discordrb/api/server.rb, line 206
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(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) click to toggle source

Update a server discord.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_channel_positions(token, server_id, positions) click to toggle source

Update a channels position discord.com/developers/docs/resources/guild#modify-guild-channel-positions

# File lib/discordrb/api/server.rb, line 104
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(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons) click to toggle source

Update integration from server discord.com/developers/docs/resources/guild#modify-guild-integration

# File lib/discordrb/api/server.rb, line 412
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_member(token, server_id, user_id, nick: :undef, roles: :undef, mute: :undef, deaf: :undef, channel_id: :undef, communication_disabled_until: :undef, reason: nil) click to toggle source

Update a user properties discord.com/developers/docs/resources/guild#modify-guild-member

# File lib/discordrb/api/server.rb, line 143
def update_member(token, server_id, user_id, nick: :undef, roles: :undef, mute: :undef, deaf: :undef, channel_id: :undef,
                  communication_disabled_until: :undef, 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,
      communication_disabled_until: communication_disabled_until
    }.reject { |_, v| v == :undef }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil, icon = :undef) click to toggle source

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) discord.com/developers/docs/resources/guild#batch-modify-guild-role @param icon [:undef, File]

# File lib/discordrb/api/server.rb, line 253
def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil, icon = :undef)
  data = { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }

  if icon != :undef && icon
    path_method = %i[original_filename path local_path].find { |meth| icon.respond_to?(meth) }

    raise ArgumentError, 'File object must respond to original_filename, path, or local path.' unless path_method
    raise ArgumentError, 'File must respond to read' unless icon.respond_to? :read

    mime_type = MIME::Types.type_for(icon.__send__(path_method)).first&.to_s || 'image/jpeg'
    data[:icon] = "data:#{mime_type};base64,#{Base64.encode64(icon.read).strip}"
  elsif icon.nil?
    data[:icon] = nil
  end

  Discordrb::API.request(
    :guilds_sid_roles_rid,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
    data.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
update_role_positions(token, server_id, roles) click to toggle source

Update role positions discord.com/developers/docs/resources/guild#modify-guild-role-positions

# File lib/discordrb/api/server.rb, line 282
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
webhooks(token, server_id) click to toggle source

Get server webhooks discord.com/developers/docs/resources/webhook#get-guild-webhooks

# File lib/discordrb/api/server.rb, line 536
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
widget(token, server_id) click to toggle source

Retrieves a server’s widget information discord.com/developers/docs/resources/guild#get-guild-widget

# File lib/discordrb/api/server.rb, line 452
def widget(token, server_id)
  Discordrb::API.request(
    :guilds_sid_embed,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/widget",
    Authorization: token
  )
end
Also aliased as: embed