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



166
167
168
169
170
171
172
 
# File 'lib/discordrb/api.rb', line 166

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



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

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



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

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



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

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



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

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, id, max_age = 0, max_uses = 0, temporary = false, xkcd = false) ⇒ Object

Create an instant invite from a server or a channel id



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

def create_invite(token, id, max_age = 0, max_uses = 0, temporary = false, xkcd = false)
  RestClient.post(
    "#{APIBASE}/channels/#{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



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

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)



184
185
186
187
188
189
190
 
# File 'lib/discordrb/api.rb', line 184

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

.create_server(token, name, region) ⇒ Object

Create a server



45
46
47
48
49
50
51
52
 
# File 'lib/discordrb/api.rb', line 45

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

.delete_channel(token, channel_id) ⇒ Object

Delete a channel



91
92
93
94
95
96
 
# File 'lib/discordrb/api.rb', line 91

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

.delete_message(token, channel_id, message_id) ⇒ Object

Delete a message



146
147
148
149
150
151
 
# File 'lib/discordrb/api.rb', line 146

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



206
207
208
209
210
211
 
# File 'lib/discordrb/api.rb', line 206

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

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

Edit a message



154
155
156
157
158
159
160
161
 
# File 'lib/discordrb/api.rb', line 154

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



244
245
246
247
248
249
 
# File 'lib/discordrb/api.rb', line 244

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

.join_server(token, invite_id) ⇒ Object

Join a server using an invite



99
100
101
102
103
104
105
 
# File 'lib/discordrb/api.rb', line 99

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

.leave_server(server_id) ⇒ Object

Leave a server



55
56
57
58
59
60
 
# File 'lib/discordrb/api.rb', line 55

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

.login(email, password) ⇒ Object

Login to the server



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

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

.logout(token) ⇒ Object

Logout from the server



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

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

.resolve_invite(token, code) ⇒ Object

Resolve an invite



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

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

.send_file(token, channel_id, file) ⇒ Object

Send a file as a message to a channel



175
176
177
178
179
180
181
 
# File 'lib/discordrb/api.rb', line 175

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



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

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)



252
253
254
255
256
257
258
 
# File 'lib/discordrb/api.rb', line 252

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

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

Update a channel’s data



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

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)



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

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



234
235
236
237
238
239
240
241
 
# File 'lib/discordrb/api.rb', line 234

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_user(token, email, password, new_username, avatar, new_password = nil) ⇒ Object

Update user data



269
270
271
272
273
274
275
276
 
# File 'lib/discordrb/api.rb', line 269

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



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

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



214
215
216
217
218
219
220
221
 
# File 'lib/discordrb/api.rb', line 214

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



261
262
263
264
265
266
 
# File 'lib/discordrb/api.rb', line 261

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