module Discordrb::API::User

API calls for User object

Public Instance Methods

avatar_url(user_id, avatar_id, format = nil) click to toggle source

Make an avatar URL from the user and avatar IDs

# File lib/discordrb/api/user.rb, line 141
def avatar_url(user_id, avatar_id, format = nil)
  format ||= if avatar_id.start_with?('a_')
               'gif'
             else
               'webp'
             end
  "#{Discordrb::API.cdn_url}/avatars/#{user_id}/#{avatar_id}.#{format}"
end
change_own_nickname(token, server_id, nick, reason = nil) click to toggle source

Change the current bot's nickname on a server

# File lib/discordrb/api/user.rb, line 32
def change_own_nickname(token, server_id, nick, reason = nil)
  Discordrb::API.request(
    :guilds_sid_members_me_nick,
    server_id, # This is technically a guild endpoint
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/members/@me/nick",
    { nick: nick }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
change_status_setting(token, status) click to toggle source

Change user status setting

# File lib/discordrb/api/user.rb, line 122
def change_status_setting(token, status)
  Discordrb::API.request(
    :users_me_settings,
    nil,
    :patch,
    "#{Discordrb::API.api_base}/users/@me/settings",
    { status: status }.to_json,
    Authorization: token,
    content_type: :json
  )
end
connections(token) click to toggle source

Get information about a user's connections discordapp.com/developers/docs/resources/user#get-users-connections

# File lib/discordrb/api/user.rb, line 111
def connections(token)
  Discordrb::API.request(
    :users_me_connections,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/@me/connections",
    Authorization: token
  )
end
create_pm(token, recipient_id) click to toggle source

Create a DM to another user discordapp.com/developers/docs/resources/user#create-dm

# File lib/discordrb/api/user.rb, line 97
def create_pm(token, recipient_id)
  Discordrb::API.request(
    :users_me_channels,
    nil,
    :post,
    "#{Discordrb::API.api_base}/users/@me/channels",
    { recipient_id: recipient_id }.to_json,
    Authorization: token,
    content_type: :json
  )
end
default_avatar(discrim = 0) click to toggle source

Returns one of the “default” discord avatars from the CDN given a discriminator

# File lib/discordrb/api/user.rb, line 135
def default_avatar(discrim = 0)
  index = discrim.to_i % 5
  "#{Discordrb::API.cdn_url}/embed/avatars/#{index}.png"
end
leave_server(token, server_id) click to toggle source

Leave a server discordapp.com/developers/docs/resources/user#leave-guild

# File lib/discordrb/api/user.rb, line 73
def leave_server(token, server_id)
  Discordrb::API.request(
    :users_me_guilds_sid,
    nil,
    :delete,
    "#{Discordrb::API.api_base}/users/@me/guilds/#{server_id}",
    Authorization: token
  )
end
profile(token) click to toggle source

Get profile data discordapp.com/developers/docs/resources/user#get-current-user

# File lib/discordrb/api/user.rb, line 21
def profile(token)
  Discordrb::API.request(
    :users_me,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/@me",
    Authorization: token
  )
end
resolve(token, user_id) click to toggle source

Get user data discordapp.com/developers/docs/resources/user#get-user

# File lib/discordrb/api/user.rb, line 9
def resolve(token, user_id)
  Discordrb::API.request(
    :users_uid,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/#{user_id}",
    Authorization: token
  )
end
servers(token) click to toggle source

Get the servers a user is connected to discordapp.com/developers/docs/resources/user#get-current-user-guilds

# File lib/discordrb/api/user.rb, line 61
def servers(token)
  Discordrb::API.request(
    :users_me_guilds,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/@me/guilds",
    Authorization: token
  )
end
update_profile(token, email, password, new_username, avatar, new_password = nil) click to toggle source

Update user data discordapp.com/developers/docs/resources/user#modify-current-user

# File lib/discordrb/api/user.rb, line 47
def update_profile(token, email, password, new_username, avatar, new_password = nil)
  Discordrb::API.request(
    :users_me,
    nil,
    :patch,
    "#{Discordrb::API.api_base}/users/@me",
    { avatar: avatar, email: email, new_password: new_password, password: password, username: new_username }.to_json,
    Authorization: token,
    content_type: :json
  )
end
user_dms(token) click to toggle source

Get the DMs for the current user discordapp.com/developers/docs/resources/user#get-user-dms

# File lib/discordrb/api/user.rb, line 85
def user_dms(token)
  Discordrb::API.request(
    :users_me_channels,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/@me/channels",
    Authorization: token
  )
end