Module: Discordrb::API::User

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

Overview

API calls for User object

Class Method Summary collapse

Class Method Details

.avatar_url(user_id, avatar_id, format = nil) ⇒ Object

Make an avatar URL from the user and avatar IDs



147
148
149
150
151
152
153
154
 
# File 'lib/discordrb/api/user.rb', line 147

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) ⇒ Object

Change the current bot's nickname on a server https://discord.com/developers/docs/resources/user#modify-current-user



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/discordrb/api/user.rb', line 33

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) ⇒ Object

Change user status setting



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/discordrb/api/user.rb', line 123

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) ⇒ Object

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



112
113
114
115
116
117
118
119
120
 
# File 'lib/discordrb/api/user.rb', line 112

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) ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/discordrb/api/user.rb', line 98

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_id = 0, legacy: false) ⇒ Object

Returns one of the "default" discord avatars from the CDN given a discriminator or id since new usernames TODO: Maybe change this method again after discriminator removal ?



137
138
139
140
141
142
143
144
 
# File 'lib/discordrb/api/user.rb', line 137

def default_avatar(discrim_id = 0, legacy: false)
  index = if legacy
            discrim_id.to_i % 5
          else
            (discrim_id.to_i >> 22) % 5
          end
  "#{Discordrb::API.cdn_url}/embed/avatars/#{index}.png"
end

.leave_server(token, server_id) ⇒ Object

Leave a server https://discord.com/developers/docs/resources/user#leave-guild



74
75
76
77
78
79
80
81
82
 
# File 'lib/discordrb/api/user.rb', line 74

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) ⇒ Object

Get profile data https://discord.com/developers/docs/resources/user#get-current-user



21
22
23
24
25
26
27
28
29
 
# 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) ⇒ Object

Get user data https://discord.com/developers/docs/resources/user#get-user



9
10
11
12
13
14
15
16
17
 
# 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) ⇒ Object

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



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

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) ⇒ Object

Update user data https://discord.com/developers/docs/resources/user#modify-current-user



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/discordrb/api/user.rb', line 48

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) ⇒ Object

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



86
87
88
89
90
91
92
93
94
 
# File 'lib/discordrb/api/user.rb', line 86

def user_dms(token)
  Discordrb::API.request(
    :users_me_channels,
    nil,
    :get,
    "#{Discordrb::API.api_base}/users/@me/channels",
    Authorization: token
  )
end