From f5ea6bb43ab7e5650510cfbef8a2e2c003b59779 Mon Sep 17 00:00:00 2001
From: jchristgit
Date: Fri, 19 Apr 2024 15:36:45 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20a72d7?=
=?UTF-8?q?25c49d16b0e1803d64b079c13e0db419ca4=20=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.build | 21 +-
404.html | 176 +--
Mix.Tasks.Gh.Docs.html | 200 +--
Nostrum.Api.Ratelimiter.html | 267 ++--
Nostrum.Api.html | 1139 +++++++++--------
Nostrum.Cache.CacheSupervisor.html | 200 +--
Nostrum.Cache.ChannelCache.ETS.html | 200 +--
Nostrum.Cache.ChannelCache.Mnesia.html | 200 +--
Nostrum.Cache.ChannelCache.NoOp.html | 200 +--
Nostrum.Cache.ChannelCache.html | 212 +--
Nostrum.Cache.ChannelGuildMapping.ETS.html | 200 +--
Nostrum.Cache.ChannelGuildMapping.Mnesia.html | 200 +--
Nostrum.Cache.ChannelGuildMapping.NoOp.html | 200 +--
Nostrum.Cache.ChannelGuildMapping.html | 219 ++--
Nostrum.Cache.GuildCache.ETS.html | 200 +--
Nostrum.Cache.GuildCache.Mnesia.html | 200 +--
Nostrum.Cache.GuildCache.NoOp.html | 200 +--
Nostrum.Cache.GuildCache.html | 215 ++--
Nostrum.Cache.Me.html | 200 +--
Nostrum.Cache.MemberCache.ETS.html | 206 +--
Nostrum.Cache.MemberCache.Mnesia.html | 200 +--
Nostrum.Cache.MemberCache.NoOp.html | 200 +--
Nostrum.Cache.MemberCache.html | 233 ++--
Nostrum.Cache.PresenceCache.ETS.html | 200 +--
Nostrum.Cache.PresenceCache.Mnesia.html | 200 +--
Nostrum.Cache.PresenceCache.NoOp.html | 200 +--
Nostrum.Cache.PresenceCache.html | 236 ++--
Nostrum.Cache.UserCache.ETS.html | 200 +--
Nostrum.Cache.UserCache.Mnesia.html | 200 +--
Nostrum.Cache.UserCache.NoOp.html | 200 +--
Nostrum.Cache.UserCache.html | 217 ++--
...onstants.ApplicationCommandOptionType.html | 200 +--
...ants.ApplicationCommandPermissionType.html | 200 +--
Nostrum.Constants.ApplicationCommandType.html | 200 +--
Nostrum.Constants.ButtonStyle.html | 200 +--
Nostrum.Constants.ChannelType.html | 200 +--
Nostrum.Constants.ComponentType.html | 200 +--
...rum.Constants.InteractionCallbackType.html | 200 +--
Nostrum.Constants.InteractionType.html | 200 +--
Nostrum.Constants.TextInputStyle.html | 200 +--
Nostrum.Constants.WebhookType.html | 200 +--
Nostrum.Consumer.html | 289 +++--
Nostrum.ConsumerGroup.html | 226 ++--
Nostrum.Error.ApiError.html | 200 +--
Nostrum.Error.CacheError.html | 194 +--
Nostrum.Error.VoiceError.html | 194 +--
Nostrum.Permission.html | 277 ++--
Nostrum.Shard.Session.html | 218 ++--
Nostrum.Shard.Supervisor.html | 206 +--
Nostrum.Snowflake.html | 271 ++--
Nostrum.StateMachineTranslator.html | 212 +--
Nostrum.Store.GuildShardMapping.ETS.html | 200 +--
Nostrum.Store.GuildShardMapping.Mnesia.html | 200 +--
Nostrum.Store.GuildShardMapping.html | 219 ++--
Nostrum.Store.Supervisor.html | 200 +--
Nostrum.Store.UnavailableGuild.ETS.html | 200 +--
Nostrum.Store.UnavailableGuild.Mnesia.html | 200 +--
Nostrum.Store.UnavailableGuild.html | 225 ++--
Nostrum.Struct.ApplicationCommand.html | 206 +--
...uct.ApplicationCommandInteractionData.html | 200 +--
...plicationCommandInteractionDataOption.html | 200 +--
...icationCommandInteractionDataResolved.html | 200 +--
Nostrum.Struct.AutoModerationRule.Action.html | 200 +--
...uct.AutoModerationRule.ActionMetadata.html | 200 +--
...ct.AutoModerationRule.TriggerMetadata.html | 200 +--
Nostrum.Struct.AutoModerationRule.html | 200 +--
Nostrum.Struct.Channel.html | 273 ++--
Nostrum.Struct.Component.ActionRow.html | 203 +--
Nostrum.Struct.Component.Button.html | 203 +--
Nostrum.Struct.Component.Option.html | 200 +--
Nostrum.Struct.Component.SelectMenu.html | 215 ++--
Nostrum.Struct.Component.TextInput.html | 203 +--
Nostrum.Struct.Component.html | 248 ++--
Nostrum.Struct.Embed.Author.html | 200 +--
Nostrum.Struct.Embed.Field.html | 200 +--
Nostrum.Struct.Embed.Footer.html | 200 +--
Nostrum.Struct.Embed.Image.html | 200 +--
Nostrum.Struct.Embed.Provider.html | 200 +--
Nostrum.Struct.Embed.Thumbnail.html | 200 +--
Nostrum.Struct.Embed.Video.html | 200 +--
Nostrum.Struct.Embed.html | 478 +++----
Nostrum.Struct.Emoji.html | 297 +++--
...truct.Event.AutoModerationRuleExecute.html | 200 +--
Nostrum.Struct.Event.ChannelPinsUpdate.html | 200 +--
Nostrum.Struct.Event.GuildBanAdd.html | 200 +--
Nostrum.Struct.Event.GuildBanRemove.html | 200 +--
...m.Struct.Event.GuildIntegrationDelete.html | 200 +--
....Struct.Event.GuildIntegrationsUpdate.html | 200 +--
...ruct.Event.GuildScheduledEventUserAdd.html | 200 +--
...t.Event.GuildScheduledEventUserRemove.html | 200 +--
Nostrum.Struct.Event.InviteCreate.html | 200 +--
Nostrum.Struct.Event.InviteDelete.html | 200 +--
Nostrum.Struct.Event.MessageDelete.html | 200 +--
Nostrum.Struct.Event.MessageDeleteBulk.html | 200 +--
Nostrum.Struct.Event.MessageReactionAdd.html | 200 +--
...um.Struct.Event.MessageReactionRemove.html | 200 +--
...Struct.Event.MessageReactionRemoveAll.html | 200 +--
...ruct.Event.MessageReactionRemoveEmoji.html | 200 +--
Nostrum.Struct.Event.PartialApplication.html | 200 +--
Nostrum.Struct.Event.PollVoteChange.html | 200 +--
Nostrum.Struct.Event.Ready.html | 200 +--
Nostrum.Struct.Event.SpeakingUpdate.html | 200 +--
Nostrum.Struct.Event.ThreadListSync.html | 200 +--
Nostrum.Struct.Event.ThreadMembersUpdate.html | 200 +--
Nostrum.Struct.Event.TypingStart.html | 200 +--
Nostrum.Struct.Event.VoiceReady.html | 200 +--
Nostrum.Struct.Event.VoiceServerUpdate.html | 200 +--
Nostrum.Struct.Event.VoiceState.html | 200 +--
Nostrum.Struct.Guild.AuditLog.html | 200 +--
Nostrum.Struct.Guild.AuditLogEntry.html | 200 +--
Nostrum.Struct.Guild.Ban.html | 200 +--
Nostrum.Struct.Guild.Integration.Account.html | 200 +--
....Struct.Guild.Integration.Application.html | 200 +--
Nostrum.Struct.Guild.Integration.html | 206 +--
Nostrum.Struct.Guild.Member.html | 267 ++--
Nostrum.Struct.Guild.Role.html | 231 ++--
...t.Guild.ScheduledEvent.EntityMetadata.html | 200 +--
Nostrum.Struct.Guild.ScheduledEvent.User.html | 203 +--
Nostrum.Struct.Guild.ScheduledEvent.html | 203 +--
Nostrum.Struct.Guild.UnavailableGuild.html | 203 +--
Nostrum.Struct.Guild.html | 239 ++--
Nostrum.Struct.Interaction.html | 200 +--
Nostrum.Struct.Invite.html | 200 +--
Nostrum.Struct.Message.Activity.html | 200 +--
Nostrum.Struct.Message.Application.html | 200 +--
Nostrum.Struct.Message.Attachment.html | 200 +--
Nostrum.Struct.Message.Component.html | 236 ++--
Nostrum.Struct.Message.Poll.Answer.html | 200 +--
Nostrum.Struct.Message.Poll.MediaObject.html | 200 +--
Nostrum.Struct.Message.Poll.Results.html | 200 +--
Nostrum.Struct.Message.Poll.html | 217 ++--
Nostrum.Struct.Message.Reaction.html | 200 +--
Nostrum.Struct.Message.Reference.html | 200 +--
Nostrum.Struct.Message.Sticker.html | 200 +--
Nostrum.Struct.Message.html | 203 +--
Nostrum.Struct.Overwrite.html | 200 +--
Nostrum.Struct.ThreadMember.html | 200 +--
Nostrum.Struct.User.Connection.html | 194 +--
Nostrum.Struct.User.Flags.html | 227 ++--
Nostrum.Struct.User.html | 283 ++--
Nostrum.Struct.VoiceRegion.html | 200 +--
Nostrum.Struct.VoiceWSState.html | 200 +--
Nostrum.Struct.WSState.html | 200 +--
Nostrum.Struct.Webhook.html | 200 +--
Nostrum.Token.html | 210 +--
Nostrum.Util.html | 206 +--
Nostrum.Voice.html | 387 +++---
Nostrum.epub | Bin 710072 -> 714530 bytes
api-reference.html | 200 +--
api.html | 227 ++--
application_commands.html | 293 +++--
assets/logo.png | Bin 0 -> 12055 bytes
dist/handlebars.templates-IHH6HKET.js | 224 ++++
dist/handlebars.templates-XWGFFSCD.js | 187 ---
dist/html-GXQ6W6IF.js | 56 +
dist/html-JDI3AVDD.js | 56 -
dist/html-elixir-2C5PUTIB.css | 6 +
dist/html-elixir-HHVY3JYD.css | 6 -
...weather-cyrillic-300-italic-M6KMXZSZ.woff2 | Bin 15244 -> 0 bytes
...weather-cyrillic-300-normal-7PAAHU3N.woff2 | Bin 15084 -> 0 bytes
...her-cyrillic-ext-300-italic-JP3ZEV2P.woff2 | Bin 20308 -> 0 bytes
...her-cyrillic-ext-300-normal-5LF5LCEK.woff2 | Bin 19320 -> 0 bytes
...rriweather-latin-300-italic-353COS6Q.woff2 | Bin 19720 -> 0 bytes
...rriweather-latin-300-normal-RWDJH4FN.woff2 | Bin 19752 -> 0 bytes
...eather-latin-ext-300-italic-MWCA36KE.woff2 | Bin 18676 -> 0 bytes
...eather-latin-ext-300-normal-K6L27CZ5.woff2 | Bin 18688 -> 0 bytes
...ather-vietnamese-300-italic-EHHNZPUO.woff2 | Bin 7996 -> 0 bytes
...ather-vietnamese-300-normal-U376L4Z4.woff2 | Bin 7796 -> 0 bytes
dist/search_data-40BAA532.js | 1 +
dist/search_items-D5B4DA13.js | 1 -
dist/sidebar_items-7079D557.js | 1 +
dist/sidebar_items-FF0CC478.js | 1 -
event_handling.html | 195 +--
gateway_intents.html | 197 +--
hot_code_upgrade.html | 213 +--
index.html | 2 +-
intro.html | 251 ++--
multi_node.html | 293 +++--
pluggable_caching.html | 235 ++--
search.html | 178 +--
state.html | 223 ++--
voice.html | 253 ++--
182 files changed, 19592 insertions(+), 15420 deletions(-)
create mode 100644 assets/logo.png
create mode 100644 dist/handlebars.templates-IHH6HKET.js
delete mode 100644 dist/handlebars.templates-XWGFFSCD.js
create mode 100644 dist/html-GXQ6W6IF.js
delete mode 100644 dist/html-JDI3AVDD.js
create mode 100644 dist/html-elixir-2C5PUTIB.css
delete mode 100644 dist/html-elixir-HHVY3JYD.css
delete mode 100644 dist/merriweather-cyrillic-300-italic-M6KMXZSZ.woff2
delete mode 100644 dist/merriweather-cyrillic-300-normal-7PAAHU3N.woff2
delete mode 100644 dist/merriweather-cyrillic-ext-300-italic-JP3ZEV2P.woff2
delete mode 100644 dist/merriweather-cyrillic-ext-300-normal-5LF5LCEK.woff2
delete mode 100644 dist/merriweather-latin-300-italic-353COS6Q.woff2
delete mode 100644 dist/merriweather-latin-300-normal-RWDJH4FN.woff2
delete mode 100644 dist/merriweather-latin-ext-300-italic-MWCA36KE.woff2
delete mode 100644 dist/merriweather-latin-ext-300-normal-K6L27CZ5.woff2
delete mode 100644 dist/merriweather-vietnamese-300-italic-EHHNZPUO.woff2
delete mode 100644 dist/merriweather-vietnamese-300-normal-U376L4Z4.woff2
create mode 100644 dist/search_data-40BAA532.js
delete mode 100644 dist/search_items-D5B4DA13.js
create mode 100644 dist/sidebar_items-7079D557.js
delete mode 100644 dist/sidebar_items-FF0CC478.js
diff --git a/.build b/.build
index 588e39c45..566e3af20 100644
--- a/.build
+++ b/.build
@@ -151,14 +151,15 @@ assets/buttons.png
assets/channel_types.png
assets/danger_button.png
assets/emoji_button.png
+assets/logo.png
assets/primary_button.png
assets/secondary_button.png
assets/select_menu.png
assets/success_button.png
dist/handlebars.runtime-NWIB6V2M.js
-dist/handlebars.templates-XWGFFSCD.js
-dist/html-JDI3AVDD.js
-dist/html-elixir-HHVY3JYD.css
+dist/handlebars.templates-IHH6HKET.js
+dist/html-GXQ6W6IF.js
+dist/html-elixir-2C5PUTIB.css
dist/inconsolata-latin-400-normal-RGKDDNDD.woff2
dist/inconsolata-latin-700-normal-DTS2D7TO.woff2
dist/inconsolata-latin-ext-400-normal-K7HVGTP7.woff2
@@ -171,19 +172,9 @@ dist/lato-latin-700-normal-2XVSBPG4.woff2
dist/lato-latin-ext-300-normal-VPGGJKJL.woff2
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
-dist/merriweather-cyrillic-300-italic-M6KMXZSZ.woff2
-dist/merriweather-cyrillic-300-normal-7PAAHU3N.woff2
-dist/merriweather-cyrillic-ext-300-italic-JP3ZEV2P.woff2
-dist/merriweather-cyrillic-ext-300-normal-5LF5LCEK.woff2
-dist/merriweather-latin-300-italic-353COS6Q.woff2
-dist/merriweather-latin-300-normal-RWDJH4FN.woff2
-dist/merriweather-latin-ext-300-italic-MWCA36KE.woff2
-dist/merriweather-latin-ext-300-normal-K6L27CZ5.woff2
-dist/merriweather-vietnamese-300-italic-EHHNZPUO.woff2
-dist/merriweather-vietnamese-300-normal-U376L4Z4.woff2
dist/remixicon-NKANDIL5.woff2
-dist/search_items-D5B4DA13.js
-dist/sidebar_items-FF0CC478.js
+dist/search_data-40BAA532.js
+dist/sidebar_items-7079D557.js
event_handling.html
gateway_intents.html
hot_code_upgrade.html
diff --git a/404.html b/404.html
index 8036475a0..4433359a5 100644
--- a/404.html
+++ b/404.html
@@ -4,20 +4,21 @@
-
+
- 404 — Nostrum v0.9.0-alpha3
-
+
-
-
-
+ 404 — Nostrum v0.9.0-alpha3
+
-
-
+
+
+
+
+
@@ -36,67 +37,96 @@
} catch (error) { }
-
+
-
Gets the bot's OAuth2 application info.
Nostrum.Api . get_application_information
- { :ok ,
- %{
+ { :ok ,
+ %{
bot_public : false ,
bot_require_code_grant : false ,
description : "Test" ,
icon : nil ,
id : "172150183260323840" ,
name : "Baba O-Riley" ,
- owner : %{
+ owner : %{
avatar : nil ,
discriminator : "0042" ,
id : "172150183260323840" ,
username : "i own a bot"
- } ,
- } }
+
} ,
+ } }
@@ -6576,13 +6603,13 @@ get_channel(channel_id)
Gets a channel.
If successful, returns {:ok, channel}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_channel ( 381889573426429952 )
- { :ok , % Nostrum.Struct.Channel { id : 381889573426429952 } }
+Nostrum.Api . get_channel ( 381889573426429952 )
+ { :ok , % Nostrum.Struct.Channel { id : 381889573426429952 } }
@@ -6642,13 +6669,13 @@ get_channel_invites(channel_id)
Gets a list of invites for a channel.
This endpoint requires the 'VIEW_CHANNEL' and 'MANAGE_CHANNELS' permissions.
If successful, returns {:ok, invite}
. Otherwise, returns a
Nostrum.Api.error/0
.
-Nostrum.Api . get_channel_invites ( 43189401384091 )
- { :ok , [ % Nostrum.Struct.Invite { } | _ ] }
+Nostrum.Api . get_channel_invites ( 43189401384091 )
+ { :ok , [ % Nostrum.Struct.Invite { } | _ ] }
@@ -6707,12 +6734,12 @@ get_channel_message(channel_id, message_id)
Retrieves a message from a channel.
This endpoint requires the 'VIEW_CHANNEL' and 'READ_MESSAGE_HISTORY' permissions.
If successful, returns {:ok, message}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_channel_message ( 43189401384091 , 198238475613443 )
+Nostrum.Api . get_channel_message ( 43189401384091 , 198238475613443 )
@@ -6775,12 +6802,12 @@ get_channel_messages(channel_id, limit, loc
Retrieves a channel's messages around a locator
up to a limit
.
This endpoint requires the 'VIEW_CHANNEL' permission. If the current user
is missing the 'READ_MESSAGE_HISTORY' permission, then this function will
return no messages.
If successful, returns {:ok, messages}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_channel_messages ( 43189401384091 , 5 , { :before , 130230401384 } )
+Nostrum.Api . get_channel_messages ( 43189401384091 , 5 , { :before , 130230401384 } )
@@ -6841,10 +6868,10 @@ get_channel_webhooks(channel_id)
Gets a list of webhooks for a channel.
channel_id
- Channel to get webhooks for.
@@ -6937,21 +6964,21 @@ get_current_user_guilds(options \\ [])
Gets a list of guilds the user is currently in.
This endpoint requires the guilds
OAuth2 scope.
If successful, returns {:ok, guilds}
. Otherwise, returns a Nostrum.Api.error/0
.
-iex> Nostrum.Api . get_current_user_guilds ( limit : 1 )
- { :ok , [ % Nostrum.Struct.Guild { } ] }
+iex> Nostrum.Api . get_current_user_guilds ( limit : 1 )
+ { :ok , [ % Nostrum.Struct.Guild { } ] }
@@ -7014,35 +7041,35 @@ get_global_application_commands(application
Fetch all global commands.
application_id
: Application ID for which to search commands.
If not given, this will be fetched from Me
.
A list of ApplicationCommand
s on success. See the official reference:
https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure
iex> Nostrum.Api . get_global_application_commands
- { :ok ,
- [
- %{
+ { :ok ,
+ [
+ %{
application_id : "455589479713865749" ,
description : "ed, man! man, ed" ,
id : "789841753196331029" ,
name : "edit"
- }
- ] }
+ }
+ ] }
@@ -7072,13 +7099,13 @@ get_guild(guild_id)
Gets a guild.
If successful, returns {:ok, guild}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild ( 81384788765712384 )
- { :ok , % Nostrum.Struct.Guild { id : 81384788765712384 } }
+Nostrum.Api . get_guild ( 81384788765712384 )
+ { :ok , % Nostrum.Struct.Guild { id : 81384788765712384 } }
@@ -7144,17 +7171,17 @@ get_guild_application_command_permissions(a
Fetches command permissions for all commands for your application in a guild.
application_id
: Application ID commands are registered under.
If not given, this will be fetched from Me
.guild_id
: Guild ID to fetch command permissions from.
This method returns a list of guild application command permission objects, see all available values on the Discord API docs .
@@ -7191,18 +7218,18 @@ get_guild_application_commands(application_
Fetch all guild application commands for the given guild.
application_id
: Application ID for which to fetch commands.
If not given, this will be fetched from Me
.guild_id
: The guild ID for which guild application commands
should be requested.
A list of ApplicationCommand
s on success. See the official reference:
https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure
@@ -7237,10 +7264,10 @@ get_guild_audit_log(guild_id, options \\ []
Get the Nostrum.Struct.Guild.AuditLog.t/0
for the given guild_id
.
:user_id
(Nostrum.Struct.User.id/0
) - filter the log for a user ID:action_type
(integer/0
) - filter the log by audit log type, see Audit Log Events :before
(t:Nostrum.Struct.Snowflake.t/0
) - filter the log before a certain entry ID:limit
(pos_integer/0
) - how many entries are returned (default 50, minimum 1, maximum 100)
@@ -7396,13 +7423,13 @@ get_guild_channels(guild_id)
Gets a list of guild channels.
If successful, returns {:ok, channels}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild_channels ( 81384788765712384 )
- { :ok , [ % Nostrum.Struct.Channel { guild_id : 81384788765712384 } | _ ] }
+Nostrum.Api . get_guild_channels ( 81384788765712384 )
+ { :ok , [ % Nostrum.Struct.Channel { guild_id : 81384788765712384 } | _ ] }
@@ -7548,13 +7575,13 @@ get_guild_invites(guild_id)
Gets a list of invites for a guild.
This endpoint requires the MANAGE_GUILD
permission.
If successful, returns {:ok, invites}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild_invites ( 81384788765712384 )
- { :ok , [ % Nostrum.Struct.Invite { } | _ ] }
+Nostrum.Api . get_guild_invites ( 81384788765712384 )
+ { :ok , [ % Nostrum.Struct.Invite { } | _ ] }
@@ -7613,12 +7640,12 @@ get_guild_member(guild_id, user_id)
Gets a guild member.
If successful, returns {:ok, member}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild_member ( 4019283754613 , 184937267485 )
+Nostrum.Api . get_guild_member ( 4019283754613 , 184937267485 )
@@ -7677,13 +7704,13 @@ get_guild_prune_count(guild_id, days)
Gets the number of members that would be removed in a prune given days
.
This endpoint requires the KICK_MEMBERS
permission.
If successful, returns {:ok, %{pruned: pruned}}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild_prune_count ( 81384788765712384 , 1 )
- { :ok , %{ pruned : 0 } }
+Nostrum.Api . get_guild_prune_count ( 81384788765712384 , 1 )
+ { :ok , %{ pruned : 0 } }
@@ -7742,12 +7769,12 @@ get_guild_roles(guild_id)
Gets a guild's roles.
If successful, returns {:ok, roles}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_guild_roles ( 147362948571673 )
+Nostrum.Api . get_guild_roles ( 147362948571673 )
@@ -7847,10 +7874,10 @@ get_guild_scheduled_event_users(guild_id, e
Get a list of users who have subscribed to an event.
All are optional, with their default values listed.
:limit
(integer) maximum number of users to return, defaults to 100
:with_member
(boolean) whether to include the member object for each user, defaults to false
:before
(Nostrum.Snowflake.t/0
) return only users before this user id, defaults to nil
:after
(Nostrum.Snowflake.t/0
) return only users after this user id, defaults to nil
@@ -7913,10 +7940,10 @@ get_guild_webhooks(guild_id)
Gets a list of webhooks for a guild.
guild_id
- Guild to get webhooks for.
@@ -7979,20 +8006,20 @@ get_invite(invite_code, options \\ [])
Gets an invite by its invite_code
.
If successful, returns {:ok, invite}
. Otherwise, returns a
Nostrum.Api.error/0
.
:with_counts
(boolean) - whether to include member count fields
-Nostrum.Api . get_invite ( "zsjUsC" )
+Nostrum.Api . get_invite ( "zsjUsC" )
- Nostrum.Api . get_invite ( "zsjUsC" , with_counts : true )
+ Nostrum.Api . get_invite ( "zsjUsC" , with_counts : true )
@@ -8084,12 +8111,12 @@ get_pinned_messages(channel_id)
Retrieves all pinned messages from a channel.
This endpoint requires the 'VIEW_CHANNEL' and 'READ_MESSAGE_HISTORY' permissions.
If successful, returns {:ok, messages}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_pinned_messages ( 43189401384091 )
+Nostrum.Api . get_pinned_messages ( 43189401384091 )
@@ -8445,13 +8472,13 @@ get_user_dms()
Gets a list of our user's DM channels.
If successful, returns {:ok, dm_channels}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . get_user_dms ( )
- { :ok , [ % Nostrum.Struct.Channel { type : 1 } | _ ] }
+Nostrum.Api . get_user_dms ( )
+ { :ok , [ % Nostrum.Struct.Channel { type : 1 } | _ ] }
@@ -8537,10 +8564,10 @@ get_webhook(webhook_id)
Gets a webhook by id.
webhook_id
- Id of the webhook to get.
@@ -8607,10 +8634,10 @@ get_webhook_with_token(webhook_id, webhook_
Gets a webhook by id and token.
This method is exactly like get_webhook/1
but does not require
authentication.
webhook_id
- Id of the webhook to get.webhook_token
- Token of the webhook to get.
@@ -8790,18 +8817,18 @@ list_guild_members(guild_id, options \\ %{}
Gets a list of a guild's members.
If successful, returns {:ok, members}
. Otherwise, returns a Nostrum.Api.error/0
.
:limit
(integer) - max number of members to return (1-1000) (default: 1):after
(Nostrum.Struct.User.id/0
) - the highest user id in the previous page (default: 0)
-Nostrum.Api . list_guild_members ( 41771983423143937 , limit : 1 )
+Nostrum.Api . list_guild_members ( 41771983423143937 , limit : 1 )
@@ -8986,16 +9013,16 @@ list_public_archived_threads(channel_id, op
Returns a list of archived threads for a given channel.
Threads are sorted by the archive_timestamp
field, in descending order.
Response body is a map with the following keys:
threads
: A list of channel objects.members
: A list of ThreadMember
objects, one for each returned thread the current user has joined.has_more
: A boolean indicating whether there are more archived threads that can be fetched.
before
: Returns threads before this timestamp, can be either a DateTime
or ISO8601 timestamp .limit
: Optional maximum number of threads to return.
@@ -9064,10 +9091,10 @@
If successful, returns {:ok, channel}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . modify_channel ( 41771983423143933 , name : "elixir-nostrum" , topic : "nostrum discussion" )
- { :ok , % Nostrum.Struct.Channel { id : 41771983423143933 , name : "elixir-nostrum" , topic : "nostrum discussion" } }
+Nostrum.Api . modify_channel ( 41771983423143933 , name : "elixir-nostrum" , topic : "nostrum discussion" )
+ { :ok , % Nostrum.Struct.Channel { id : 41771983423143933 , name : "elixir-nostrum" , topic : "nostrum discussion" } }
- Nostrum.Api . modify_channel ( 41771983423143933 )
- { :ok , % Nostrum.Struct.Channel { id : 41771983423143933 } }
+ Nostrum.Api . modify_channel ( 41771983423143933 )
+ { :ok , % Nostrum.Struct.Channel { id : 41771983423143933 } }
@@ -9148,18 +9175,18 @@ modify_current_user(options)
Changes the username or avatar of the current user.
:username
(string) - new username:avatar
(string) - the user's avatar as avatar data
-Nostrum.Api . modify_current_user ( avatar : "data:image/jpeg;base64,YXl5IGJieSB1IGx1a2luIDQgc3VtIGZ1az8=" )
+Nostrum.Api . modify_current_user ( avatar : "data:image/jpeg;base64,YXl5IGJieSB1IGx1a2luIDQgc3VtIGZ1az8=" )
@@ -9219,19 +9246,19 @@ modify_current_user_nick(guild_id, options
Modifies the nickname of the current user in a guild.
If successful, returns {:ok, %{nick: nick}}
. Otherwise, returns a Nostrum.Api.error/0
.
:nick
(string) - value to set users nickname to
-Nostrum.Api . modify_current_user_nick ( 41771983423143937 , nick : "Nostrum" )
- { :ok , %{ nick : "Nostrum" } }
+Nostrum.Api . modify_current_user_nick ( 41771983423143937 , nick : "Nostrum" )
+ { :ok , %{ nick : "Nostrum" } }
@@ -9301,10 +9328,10 @@ modify_guild(guild_id, options \\ [], reaso
Modifies a guild's settings.
This endpoint requires the MANAGE_GUILD
permission. It fires the
Nostrum.Consumer.guild_update/0
event.
An optional reason
can be provided for the audit log.
If successful, returns {:ok, guild}
. Otherwise, returns a Nostrum.Api.error/0
.
:name
(string) - guild name:region
(string) - guild voice region id:verification_level
(integer) - verification level:default_message_notifications
(integer) - default message
notification level:explicit_content_filter
(integer) - explicit content filter level:afk_channel_id
(Nostrum.Snowflake.t/0
) - id for afk channel:afk_timeout
(integer) - afk timeout in seconds:icon
(base64 data URI) - 128x128 jpeg image for the guild icon:owner_id
(Nostrum.Snowflake.t/0
) - user id to transfer
@@ -9313,13 +9340,13 @@ modify_guild(guild_id, options \\ [], reaso
channel to which system messages are sent :rules_channel_id
(Nostrum.Snowflake.t/0
) - the id of the channel that
is used for rules in public guilds:public_updates_channel_id
(Nostrum.Snowflake.t/0
) - the id of the channel
where admins and moderators receive notices from Discord in public guilds
-Nostrum.Api . modify_guild ( 451824027976073216 , name : "Nose Drum" )
- { :ok , % Nostrum.Struct.Guild { id : 451824027976073216 , name : "Nose Drum" , ... } }
+Nostrum.Api . modify_guild ( 451824027976073216 , name : "Nose Drum" )
+ { :ok , % Nostrum.Struct.Guild { id : 451824027976073216 , name : "Nose Drum" , ... } }
@@ -9417,13 +9444,13 @@ modify_guild_channel_positions(guild_id, po
Reorders a guild's channels.
This endpoint requires the MANAGE_CHANNELS
permission. It fires multiple
Nostrum.Consumer.channel_update/0
events.
If successful, returns {:ok, channels}
. Otherwise, returns a Nostrum.Api.error/0
.
positions
is a list of maps that each map a channel id with a position.
-Nostrum.Api . modify_guild_channel_positions ( 279093381723062272 , [ %{ id : 351500354581692420 , position : 2 } ] )
- { :ok }
+Nostrum.Api . modify_guild_channel_positions ( 279093381723062272 , [ %{ id : 351500354581692420 , position : 2 } ] )
+ { :ok }
@@ -9493,18 +9520,18 @@ modify_guild_emoji(guild_id, emoji_id, opti
Modify the given emoji.
This endpoint requires the MANAGE_EMOJIS
permission. It fires a
Nostrum.Consumer.guild_emojis_update/0
event.
An optional reason
can be provided for the audit log.
If successful, returns {:ok, emoji}
. Otherwise, returns Nostrum.Api.error/0
.
:name
(string) - name of the emoji:roles
(list of Nostrum.Snowflake.t/0
) - roles to which this emoji will be whitelisted
-Nostrum.Api . modify_guild_emoji ( 43189401384091 , 4314301984301 , name : "elixir" , roles : [ ] )
+Nostrum.Api . modify_guild_emoji ( 43189401384091 , 4314301984301 , name : "elixir" , roles : [ ] )
@@ -9611,19 +9638,19 @@ modify_guild_member(guild_id, user_id, opti
Modifies a guild member's attributes.
This endpoint fires the Nostrum.Consumer.guild_member_update/0
event.
It situationally requires the MANAGE_NICKNAMES
, MANAGE_ROLES
,
MUTE_MEMBERS
, DEAFEN_MEMBERS
, and MOVE_MEMBERS
permissions.
If successful, returns {:ok, member}
. Otherwise, returns a Nostrum.Api.error/0
.
An optional reason
argument can be given for the audit log.
:nick
(string) - value to set users nickname to:roles
(list of Nostrum.Snowflake.t/0
) - array of role ids the member is assigned:mute
(boolean) - if the user is muted:deaf
(boolean) - if the user is deafened:channel_id
(Nostrum.Snowflake.t/0
) - id of channel to move user to (if they are connected to voice):communication_disabled_until
(DateTime.t/0
or nil
) - datetime to disable user communication (timeout) until, or nil
to remove timeout.
-Nostrum.Api . modify_guild_member ( 41771983423143937 , 637162356451 , nick : "Nostrum" )
- { :ok , % Nostrum.Struct.Member { } }
+Nostrum.Api . modify_guild_member ( 41771983423143937 , 637162356451 , nick : "Nostrum" )
+ { :ok , % Nostrum.Struct.Member { } }
@@ -9697,18 +9724,18 @@ modify_guild_role(guild_id, role_id, option
Modifies a guild role.
This endpoint requires the MANAGE_ROLES
permission. It fires a
Nostrum.Consumer.guild_role_update/0
event.
An optional reason
can be specified for the audit log.
If successful, returns {:ok, role}
. Otherwise, returns a Nostrum.Api.error/0
.
:name
(string) - name of the role:permissions
(integer) - bitwise of the enabled/disabled permissions:color
(integer) - RGB color value (default: 0):hoist
(boolean) - whether the role should be displayed separately in the sidebar:mentionable
(boolean) - whether the role should be mentionable
-Nostrum.Api . modify_guild_role ( 41771983423143937 , 392817238471936 , hoist : false , name : "foo-bar" )
+Nostrum.Api . modify_guild_role ( 41771983423143937 , 392817238471936 , hoist : false , name : "foo-bar" )
@@ -9779,12 +9806,12 @@ modify_guild_role_positions(guild_id, posit
Reorders a guild's roles.
This endpoint requires the MANAGE_ROLES
permission. It fires multiple
Nostrum.Consumer.guild_role_update/0
events.
If successful, returns {:ok, roles}
. Otherwise, returns a Nostrum.Api.error/0
.
positions
is a list of maps that each map a role id with a position.
-Nostrum.Api . modify_guild_role_positions ( 41771983423143937 , [ %{ id : 41771983423143936 , position : 2 } ] )
+Nostrum.Api . modify_guild_role_positions ( 41771983423143937 , [ %{ id : 41771983423143936 , position : 2 } ] )
@@ -9919,10 +9946,10 @@ modify_webhook(webhook_id, args, reason \\
Modifies a webhook.
webhook_id
- Id of the webhook to modify.args
- Map with the following optional keys:name
- Name of the webhook.avatar
- Base64 128x128 jpeg image for the default avatar.reason
- An optional reason for the guild audit log.
@@ -9961,10 +9988,10 @@ modify_webhook_with_token(webhook_id, webho
Modifies a webhook with a token.
This method is exactly like modify_webhook/1
but does not require
authentication.
webhook_id
- Id of the webhook to modify.webhook_token
- Token of the webhook to get.args
- Map with the following optional keys:name
- Name of the webhook.avatar
- Base64 128x128 jpeg image for the default avatar.reason
- An optional reason for the guild audit log.
@@ -10038,13 +10065,13 @@ remove_guild_member(guild_id, user_id, reas
Removes a member from a guild.
This event requires the KICK_MEMBERS
permission. It fires a
Nostrum.Consumer.guild_member_remove/0
event.
An optional reason can be provided for the audit log with reason
.
If successful, returns {:ok}
. Otherwise, returns a Nostrum.Api.error/0
.
-Nostrum.Api . remove_guild_member ( 1453827904102291 , 18739485766253 )
- { :ok }
+Nostrum.Api . remove_guild_member ( 1453827904102291 , 18739485766253 )
+ { :ok }
@@ -10275,10 +10302,10 @@ start_thread(channel_id, options, reason \\
Create a thread on a channel without an associated message.
If successful, returns {:ok, Channel}
. Otherwise returns a Nostrum.Api.error/0
.
An optional reason
argument can be given for the audit log.
name
: Name of the thread, max 100 characters.type
: Type of thread, can be either 11 (GUILD_PUBLIC_THREAD
) or 12 (GUILD_PRIVATE_THREAD
).auto_archive_duration
: Duration in minutes to auto-archive the thread after it has been inactive, can be set to 60, 1440, 4320, or 10080.invitable
: whether non-moderators can add other non-moderators to a thread; only available when creating a private thread defaults to false
.rate_limit_per_user
: Rate limit per user in seconds, can be set to any value in 0..21600
.
@@ -10317,16 +10344,16 @@ start_thread_in_forum_channel(channel_id, o
Create a new thread in a forum channel.
If successful, returns {:ok, Channel}
. Otherwise returns a Nostrum.Api.error/0
.
An optional reason
argument can be given for the audit log.
name
: Name of the thread, max 100 characters.auto_archive_duration
: Duration in minutes to auto-archive the thread after it has been inactive, can be set to 60, 1440, 4320, or 10080.rate_limit_per_user
: Rate limit per user in seconds, can be set to any value in 0..21600
.applied_tags
: An array of tag ids to apply to the thread.message
: The first message in the created thread.
content
: The content of the message.embeds
: A list of embeds.allowed_mentions
: Allowed mentions object.components
: A list of components.sticker_ids
: A list of sticker ids.:files
- a list of files where each element is the same format as the :file
option. If both
:file
and :files
are specified, :file
will be prepended to the :files
list.At least one of content
, embeds
, sticker_ids
, or files
must be specified.
@@ -10367,10 +10394,10 @@ start_thread_with_message(channel_id, messa
Create a thread on a channel message.
The thread_id
will be the same as the id of the message, as such no message can have more than one thread.
If successful, returns {:ok, Channel}
. Otherwise returns a Nostrum.Api.error/0
.
An optional reason
argument can be given for the audit log.
name
: Name of the thread, max 100 characters.auto_archive_duration
: Duration in minutes to auto-archive the thread after it has been inactive, can be set to 60, 1440, 4320, or 10080.rate_limit_per_user
: Rate limit per user in seconds, can be set to any value in 0..21600
.
@@ -10491,10 +10518,10 @@ update_shard_status(pid, status, game, type
Updates the status of the bot for a certain shard.
@@ -10574,41 +10601,39 @@ update_voice_state(guild_id, channel_id, se
-
-
+
-
+
diff --git a/Nostrum.Cache.CacheSupervisor.html b/Nostrum.Cache.CacheSupervisor.html
index fe423185a..fb9c3cabc 100644
--- a/Nostrum.Cache.CacheSupervisor.html
+++ b/Nostrum.Cache.CacheSupervisor.html
@@ -4,20 +4,19 @@
-
+
+
Nostrum.Cache.CacheSupervisor — Nostrum v0.9.0-alpha3
-
+
-
-
-
-
-
-
+
+
+
+
@@ -36,91 +35,121 @@
} catch (error) { }
-