Module: Discordrb::API

Defined in:
lib/discordrb/api.rb

Overview

List of methods representing endpoints in Discord’s API

Constant Summary collapse

APIBASE = 
'https://discordapp.com/api'

Class Method Summary collapse

Class Method Details

.acknowledge_message(token, channel_id, message_id) ⇒ Object

Acknowledge that a message has been received The last acknowledged message will be sent in the ready packet, so this is an easy way to catch up on messages



208
209
210
211
212
213
214
 
# File 'lib/discordrb/api.rb', line 208

def acknowledge_message(token, channel_id, message_id)
  RestClient.post(
    "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}/ack",
    nil,
    Authorization: token
  )
end

.ban_user(token, server_id, user_id, message_days) ⇒ Object

Ban a user from a server and delete their messages from the last message_days days



11
12
13
14
15
16
 
# File 'lib/discordrb/api.rb', line 11

def ban_user(token, server_id, user_id, message_days)
  RestClient.put(
    "#{APIBASE}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
    Authorization: token
  )
end

.bans(token, server_id) ⇒ Object

Get a server’s banned users



35
36
37
38
39
40
 
# File 'lib/discordrb/api.rb', line 35

def bans(token, server_id)
  RestClient.get(
    "#{APIBASE}/guilds/#{server_id}/bans",
    Authorization: token
  )
end

.channel(token, channel_id) ⇒ Object

Get a channel’s data



97
98
99
100
101
102
 
# File 'lib/discordrb/api.rb', line 97

def channel(token, channel_id)
  RestClient.get(
    "#{APIBASE}/channels/#{channel_id}",
    Authorization: token
  )
end

.channel_log(token, channel_id, amount, before = nil, after = nil) ⇒ Object

Get a list of messages from a channel’s history



321
322
323
324
325
326
 
# File 'lib/discordrb/api.rb', line 321

def channel_log(token, channel_id, amount, before = nil, after = nil)
  RestClient.get(
    "#{APIBASE}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}",
    Authorization: token
  )
end

.create_channel(token, server_id, name, type) ⇒ Object

Create a channel



105
106
107
108
109
110
111
112
 
# File 'lib/discordrb/api.rb', line 105

def create_channel(token, server_id, name, type)
  RestClient.post(
    "#{APIBASE}/guilds/#{server_id}/channels",
    { 'name' => name, 'type' => type }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, xkcd = false) ⇒ Object

Create an instant invite from a server or a channel id



160
161
162
163
164
165
166
167
 
# File 'lib/discordrb/api.rb', line 160

def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, xkcd = false)
  RestClient.post(
    "#{APIBASE}/channels/#{channel_id}/invites",
    { 'max_age' => max_age, 'max_uses' => max_uses, 'temporary' => temporary, 'xkcdpass' => xkcd }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.create_private(token, bot_user_id, user_id) ⇒ Object

Create a private channel



150
151
152
153
154
155
156
157
 
# File 'lib/discordrb/api.rb', line 150

def create_private(token, bot_user_id, user_id)
  RestClient.post(
    "#{APIBASE}/users/#{bot_user_id}/channels",
    { 'recipient_id' => user_id }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.create_role(token, server_id) ⇒ Object

Create a role (parameters such as name and colour will have to be set by update_role afterwards)



226
227
228
229
230
231
232
 
# File 'lib/discordrb/api.rb', line 226

def create_role(token, server_id)
  RestClient.post(
    "#{APIBASE}/guilds/#{server_id}/roles",
    nil,
    Authorization: token
  )
end

.create_server(token, name, region = :london) ⇒ Object

Create a server



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

def create_server(token, name, region = :london)
  RestClient.post(
    "#{APIBASE}/guilds",
    { 'name' => name, 'region' => region.to_s }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.delete_channel(token, channel_id) ⇒ Object

Delete a channel



125
126
127
128
129
130
 
# File 'lib/discordrb/api.rb', line 125

def delete_channel(token, channel_id)
  RestClient.delete(
    "#{APIBASE}/channels/#{channel_id}",
    Authorization: token
  )
end

.delete_invite(token, code) ⇒ Object

Delete an invite by code



170
171
172
173
174
175
 
# File 'lib/discordrb/api.rb', line 170

def delete_invite(token, code)
  RestClient.delete(
    "#{APIBASE}/invites/#{code}",
    Authorization: token
  )
end

.delete_message(token, channel_id, message_id) ⇒ Object

Delete a message



188
189
190
191
192
193
 
# File 'lib/discordrb/api.rb', line 188

def delete_message(token, channel_id, message_id)
  RestClient.delete(
    "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}",
    Authorization: token
  )
end

.delete_role(token, server_id, role_id) ⇒ Object

Delete a role



248
249
250
251
252
253
 
# File 'lib/discordrb/api.rb', line 248

def delete_role(token, server_id, role_id)
  RestClient.delete(
    "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
    Authorization: token
  )
end

.delete_server(token, server_id) ⇒ Object

Delete a server



81
82
83
84
85
86
 
# File 'lib/discordrb/api.rb', line 81

def delete_server(token, server_id)
  RestClient.delete(
    "#{APIBASE}/guilds/#{server_id}",
    Authorization: token
  )
end

.edit_message(token, channel_id, message_id, message, mentions = []) ⇒ Object

Edit a message



196
197
198
199
200
201
202
203
 
# File 'lib/discordrb/api.rb', line 196

def edit_message(token, channel_id, message_id, message, mentions = [])
  RestClient.patch(
    "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}",
    { 'content' => message, 'mentions' => mentions }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.gateway(token) ⇒ Object

Get the gateway to be used



286
287
288
289
290
291
 
# File 'lib/discordrb/api.rb', line 286

def gateway(token)
  RestClient.get(
    "#{APIBASE}/gateway",
    Authorization: token
  )
end

.join_server(token, invite_code) ⇒ Object

Join a server using an invite



133
134
135
136
137
138
139
 
# File 'lib/discordrb/api.rb', line 133

def join_server(token, invite_code)
  RestClient.post(
    "#{APIBASE}/invite/#{invite_code}",
    nil,
    Authorization: token
  )
end

.kick_user(token, server_id, user_id) ⇒ Object

Kick a user from a server



27
28
29
30
31
32
 
# File 'lib/discordrb/api.rb', line 27

def kick_user(token, server_id, user_id)
  RestClient.delete(
    "#{APIBASE}/guilds/#{server_id}/members/#{user_id}",
    Authorization: token
  )
end

.leave_server(server_id) ⇒ Object

Leave a server



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

def leave_server(server_id)
  RestClient.delete(
    "#{APIBASE}/guilds/#{server_id}",
    Authorization: token
  )
end

.login(email, password) ⇒ Object

Login to the server



43
44
45
46
47
48
49
 
# File 'lib/discordrb/api.rb', line 43

def (email, password)
  RestClient.post(
    "#{APIBASE}/auth/login",
    email: email,
    password: password
  )
end

.logout(token) ⇒ Object

Logout from the server



52
53
54
55
56
57
58
 
# File 'lib/discordrb/api.rb', line 52

def logout(token)
  RestClient.post(
    "#{APIBASE}/auth/logout",
    nil,
    Authorization: token
  )
end

.resolve_invite(token, invite_code) ⇒ Object

Resolve an invite



142
143
144
145
146
147
 
# File 'lib/discordrb/api.rb', line 142

def resolve_invite(token, invite_code)
  RestClient.get(
    "#{APIBASE}/invite/#{invite_code}",
    Authorization: token
  )
end

.send_file(token, channel_id, file) ⇒ Object

Send a file as a message to a channel



217
218
219
220
221
222
223
 
# File 'lib/discordrb/api.rb', line 217

def send_file(token, channel_id, file)
  RestClient.post(
    "#{APIBASE}/channels/#{channel_id}/messages",
    { file: file },
    Authorization: token
  )
end

.send_message(token, channel_id, message, mentions = [], tts = false) ⇒ Object

Send a message to a channel



178
179
180
181
182
183
184
185
 
# File 'lib/discordrb/api.rb', line 178

def send_message(token, channel_id, message, mentions = [], tts = false)
  RestClient.post(
    "#{APIBASE}/channels/#{channel_id}/messages",
    { 'content' => message, 'mentions' => mentions, tts => tts }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.start_typing(token, channel_id) ⇒ Object

Start typing (needs to be resent every 5 seconds to keep up the typing)



294
295
296
297
298
299
300
 
# File 'lib/discordrb/api.rb', line 294

def start_typing(token, channel_id)
  RestClient.post(
    "#{APIBASE}/channels/#{channel_id}/typing",
    nil,
    Authorization: token
  )
end

.unban_user(token, server_id, user_id) ⇒ Object

Unban a user from a server



19
20
21
22
23
24
 
# File 'lib/discordrb/api.rb', line 19

def unban_user(token, server_id, user_id)
  RestClient.delete(
    "#{APIBASE}/guilds/#{server_id}/bans/#{user_id}",
    Authorization: token
  )
end

.update_channel(token, channel_id, name, topic, position = 0) ⇒ Object

Update a channel’s data



115
116
117
118
119
120
121
122
 
# File 'lib/discordrb/api.rb', line 115

def update_channel(token, channel_id, name, topic, position = 0)
  RestClient.patch(
    "#{APIBASE}/channels/#{channel_id}",
    { 'name' => name, 'position' => position, 'topic' => topic }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_role(token, server_id, role_id, name, colour, hoist = false, packed_permissions = 36_953_089) ⇒ Object

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)



238
239
240
241
242
243
244
245
 
# File 'lib/discordrb/api.rb', line 238

def update_role(token, server_id, role_id, name, colour, hoist = false, packed_permissions = 36_953_089)
  RestClient.patch(
    "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
    { 'color' => colour, 'name' => name, 'hoist' => hoist, 'permissions' => packed_permissions }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_role_overrides(token, channel_id, role_id, allow, deny) ⇒ Object

Update a role’s permission overrides in a channel



276
277
278
279
280
281
282
283
 
# File 'lib/discordrb/api.rb', line 276

def update_role_overrides(token, channel_id, role_id, allow, deny)
  RestClient.put(
    "#{APIBASE}/channels/#{channel_id}/permissions/#{role_id}",
    { 'type' => 'role', 'id' => role_id, 'allow' => allow, 'deny' => deny }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_server(token, server_id, name, region, icon, afk_channel_id, afk_timeout) ⇒ Object

Update a server



71
72
73
74
75
76
77
78
 
# File 'lib/discordrb/api.rb', line 71

def update_server(token, server_id, name, region, icon, afk_channel_id, afk_timeout)
  RestClient.patch(
    "#{APIBASE}/guilds/#{server_id}",
    { 'name' => name, 'region' => region, 'icon' => icon, 'afk_channel_id' => afk_channel_id, 'afk_timeout' => afk_timeout }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_user(token, email, password, new_username, avatar, new_password = nil) ⇒ Object

Update user data



311
312
313
314
315
316
317
318
 
# File 'lib/discordrb/api.rb', line 311

def update_user(token, email, password, new_username, avatar, new_password = nil)
  RestClient.patch(
    "#{APIBASE}/users/@me",
    { 'avatar' => avatar, 'email' => email, 'new_password' => new_password, 'password' => password, 'username' => new_username }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_user_overrides(token, channel_id, user_id, allow, deny) ⇒ Object

Update a user’s permission overrides in a channel



266
267
268
269
270
271
272
273
 
# File 'lib/discordrb/api.rb', line 266

def update_user_overrides(token, channel_id, user_id, allow, deny)
  RestClient.put(
    "#{APIBASE}/channels/#{channel_id}/permissions/#{user_id}",
    { 'type' => 'member', 'id' => user_id, 'allow' => allow, 'deny' => deny }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_user_roles(token, server_id, user_id, roles) ⇒ Object

Update a user’s roles



256
257
258
259
260
261
262
263
 
# File 'lib/discordrb/api.rb', line 256

def update_user_roles(token, server_id, user_id, roles)
  RestClient.patch(
    "#{APIBASE}/guilds/#{server_id}/members/#{user_id}",
    { 'roles' => roles }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.user(token, user_id) ⇒ Object

Get user data



303
304
305
306
307
308
 
# File 'lib/discordrb/api.rb', line 303

def user(token, user_id)
  RestClient.get(
    "#{APIBASE}/users/#{user_id}",
    Authorization: token
  )
end