Search
Nostrum
v0.10.4
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.1
v0.9.0
v0.9.0-rc1
v0.9.0-alpha2
v0.9.0-alpha1
v0.8.0
v0.8.0-beta1
v0.8.0-alpha1
v0.7.0
v0.7.0-rc2
v0.7.0-rc1
v0.6.1
v0.6.0
v0.5.1
v0.5.0
v0.5.0-rc2
v0.5.0-rc1
v0.4.6
v0.4.5
v0.4.3
v0.4.2
v0.4.1
v0.4.0
v0.3.2
v0.3.1
v0.2.1
v0.2.0
Pages
Modules
Mix
Tasks
Api
Nostrum.Api
Summary
Types
allowed_mention/0
allowed_mentions/0
emoji/0
error/0
limit/0
locator/0
matrix/0
options/0
status/0
thread_with_message_params/0
thread_without_message_params/0
Functions
add_guild_member/3
add_guild_member!/3
add_guild_member_role/4
add_pinned_channel_message/2
add_pinned_channel_message!/2
add_thread_member/2
batch_edit_application_command_permissions/3
begin_guild_prune/3
begin_guild_prune!/3
bulk_delete_messages/3
bulk_delete_messages!/3
bulk_overwrite_global_application_commands/2
bulk_overwrite_guild_application_commands/3
create_channel_invite/3
create_channel_invite!/3
create_dm/1
create_dm!/1
create_followup_message/3
create_followup_message!/3
create_global_application_command/2
create_group_dm/2
create_group_dm!/2
create_guild_application_command/3
create_guild_auto_moderation_rule/2
create_guild_ban/4
create_guild_channel/2
create_guild_channel!/2
create_guild_emoji/3
create_guild_emoji!/3
create_guild_integrations/2
create_guild_role/3
create_guild_role!/3
create_guild_scheduled_event/3
create_interaction_response/2
create_interaction_response/3
create_interaction_response!/2
create_interaction_response!/3
create_message/2
create_message!/2
create_reaction/3
create_reaction!/3
create_webhook/3
delete_all_reactions/2
delete_all_reactions!/2
delete_channel/2
delete_channel!/2
delete_channel_permissions/3
delete_global_application_command/2
delete_guild/1
delete_guild!/1
delete_guild_application_command/3
delete_guild_auto_moderation_rule/2
delete_guild_emoji/3
delete_guild_emoji!/3
delete_guild_integrations/2
delete_guild_role/3
delete_guild_role!/3
delete_guild_scheduled_event/2
delete_interaction_followup_message/3
delete_interaction_followup_message!/3
delete_interaction_response/1
delete_interaction_response/2
delete_interaction_response!/1
delete_interaction_response!/2
delete_invite/1
delete_invite!/1
delete_message/1
delete_message/2
delete_message!/1
delete_message!/2
delete_own_reaction/3
delete_own_reaction!/3
delete_pinned_channel_message/2
delete_pinned_channel_message!/2
delete_reaction/3
delete_reaction!/3
delete_user_reaction/4
delete_user_reaction!/4
delete_webhook/2
edit_application_command_permissions/4
edit_channel_permissions/4
edit_channel_permissions!/4
edit_global_application_command/3
edit_guild_application_command/4
edit_interaction_response/2
edit_interaction_response/3
edit_interaction_response!/2
edit_interaction_response!/3
edit_message/2
edit_message/3
edit_message!/2
edit_message!/3
edit_webhook_message/4
execute_git_webhook/3
execute_slack_webhook/3
execute_webhook/4
get_application_command_permissions/3
get_application_information/0
get_channel/1
get_channel!/1
get_channel_invites/1
get_channel_invites!/1
get_channel_message/2
get_channel_message!/2
get_channel_messages/3
get_channel_messages!/3
get_channel_webhooks/1
get_current_user/0
get_current_user!/0
get_current_user_guilds/1
get_current_user_guilds!/1
get_global_application_commands/1
get_guild/1
get_guild!/1
get_guild_application_command_permissions/2
get_guild_application_commands/2
get_guild_audit_log/2
get_guild_auto_moderation_rule/2
get_guild_auto_moderation_rules/1
get_guild_ban/2
get_guild_bans/1
get_guild_channels/1
get_guild_channels!/1
get_guild_emoji/2
get_guild_emoji!/2
get_guild_integrations/1
get_guild_invites/1
get_guild_invites!/1
get_guild_member/2
get_guild_member!/2
get_guild_prune_count/2
get_guild_prune_count!/2
get_guild_roles/1
get_guild_roles!/1
get_guild_scheduled_event/2
get_guild_scheduled_event_users/3
get_guild_scheduled_events/1
get_guild_webhooks/1
get_guild_widget/1
get_invite/2
get_invite!/2
get_original_interaction_response/1
get_pinned_messages/1
get_pinned_messages!/1
get_reactions/4
get_reactions!/4
get_thread_member/2
get_thread_members/1
get_token/0
get_user/1
get_user!/1
get_user_connections/0
get_user_dms/0
get_user_dms!/0
get_voice_region/1
get_webhook/1
get_webhook_message/2
get_webhook_with_token/2
join_thread/1
leave_guild/1
leave_thread/1
list_guild_emojis/1
list_guild_emojis!/1
list_guild_members/2
list_guild_members!/2
list_guild_threads/1
list_joined_private_archived_threads/2
list_private_archived_threads/2
list_public_archived_threads/2
list_voice_regions/0
modify_channel/3
modify_channel!/3
modify_current_user/1
modify_current_user!/1
modify_current_user_nick/2
modify_current_user_nick!/2
modify_guild/3
modify_guild!/2
modify_guild_auto_moderation_rule/3
modify_guild_channel_positions/2
modify_guild_channel_positions!/2
modify_guild_emoji/4
modify_guild_emoji!/4
modify_guild_integrations/3
modify_guild_member/4
modify_guild_member!/4
modify_guild_role/4
modify_guild_role!/4
modify_guild_role_positions/3
modify_guild_role_positions!/3
modify_guild_scheduled_event/4
modify_guild_widget/2
modify_webhook/3
modify_webhook_with_token/4
remove_guild_ban/3
remove_guild_member/3
remove_guild_member!/3
remove_guild_member_role/4
remove_thread_member/2
request/1
request/4
request_multipart/4
start_thread/3
start_thread_in_forum_channel/3
start_thread_with_message/4
start_typing/1
start_typing!/1
sync_guild_integrations/2
update_shard_status/5
update_status/4
update_voice_state/4
Nostrum.Api.Ratelimiter
Sections
Purpose
Inner workings
Summary
Types
on_start/0
Functions
child_spec/1
get_endpoint/2
init/1
queue/2
start_link/1
Nostrum.Consumer
Sections
Consuming gateway events
Running multiple consumers
Example consumer
Summary
Types
auto_moderation_rule_create/0
auto_moderation_rule_delete/0
auto_moderation_rule_execute/0
auto_moderation_rule_update/0
channel_create/0
channel_delete/0
channel_pins_ack/0
channel_pins_update/0
channel_update/0
event/0
guild_audit_log_entry_create/0
guild_available/0
guild_ban_add/0
guild_ban_remove/0
guild_create/0
guild_delete/0
guild_emojis_update/0
guild_integrations_update/0
guild_member_add/0
guild_member_remove/0
guild_member_update/0
guild_members_chunk/0
guild_role_create/0
guild_role_delete/0
guild_role_update/0
guild_scheduled_event_create/0
guild_scheduled_event_delete/0
guild_scheduled_event_update/0
guild_scheduled_event_user_add/0
guild_scheduled_event_user_remove/0
guild_unavailable/0
guild_update/0
integration_create/0
integration_delete/0
integration_update/0
interaction_create/0
message_ack/0
message_create/0
message_delete/0
message_delete_bulk/0
message_reaction_add/0
message_reaction_remove/0
message_reaction_remove_all/0
message_reaction_remove_emoji/0
message_update/0
presence_update/0
ready/0
resumed/0
thread_create/0
thread_delete/0
thread_list_sync/0
thread_member_update/0
thread_members_update/0
thread_update/0
typing_start/0
user_settings_update/0
user_update/0
voice_incoming_packet/0
voice_ready/0
voice_server_update/0
voice_speaking_update/0
voice_state_update/0
webhooks_update/0
Callbacks
handle_event/1
Nostrum.ConsumerGroup
Summary
Functions
child_spec/1
dispatch/1
join/0
join/1
start_link/1
Nostrum.Permission
Summary
Types
bit/0
bitset/0
general_permission/0
t/0
text_permission/0
voice_permission/0
Functions
all/0
from_bit/1
from_bit!/1
from_bitset/1
is_permission/1
to_bit/1
to_bitset/1
Nostrum.Voice
Sections
Voice Without FFmpeg
Summary
Types
opus_packet/0
play_input/0
play_type/0
rtp_opus/0
rtp_sequence/0
rtp_ssrc/0
rtp_timestamp/0
Functions
child_spec/1
connect_to_gateway/1
create_ogg_bitstream/1
extract_opus_packet/1
get_channel_id/1
get_current_url/1
get_ssrc_map/1
join_channel/5
leave_channel/1
listen/3
pad_opus/1
pause/1
play/4
playing?/1
ready?/1
resume/1
send_frames/2
set_is_speaking/2
start_listen_async/1
stop/1
stop_listen_async/1
Cache
Nostrum.Cache
.CacheSupervisor
Summary
Functions
child_spec/1
init/1
start_link/1
.ChannelCache
Sections
Writing your own channel cache
Summary
Types
reason/0
Callbacks
child_spec/1
create/1
delete/1
query_handle/0
update/1
wrap_qlc/1
Functions
get/1
get/2
get!/1
get!/2
query_handle/0
.ChannelGuildMapping
Sections
Purpose
Configuration
Summary
Callbacks
child_spec/1
create/2
delete/1
get/1
Functions
create/2
delete/1
get/1
.GuildCache
Sections
Writing your own guild cache
Summary
Types
selector/0
Callbacks
channel_create/2
channel_delete/2
channel_update/2
child_spec/1
create/1
delete/1
emoji_update/2
member_count_down/1
member_count_up/1
query_handle/0
role_create/2
role_delete/2
role_update/2
update/1
voice_state_update/2
wrap_qlc/1
Functions
all/1
fold/3
get/2
get!/1
query_handle/0
select/2
select!/2
select_all/1
wrap_qlc/2
.Me
Summary
Functions
child_spec/1
get/0
start_link/1
.MemberCache
Summary
Callbacks
bulk_create/2
child_spec/1
create/2
delete/2
query_handle/0
update/2
wrap_qlc/1
Functions
fold/4
fold_by_user/4
fold_with_users/4
get/3
get_with_user/3
query_handle/0
wrap_qlc/2
.PresenceCache
Sections
Writing your own presence cache
Summary
Types
presence/0
Callbacks
bulk_create/2
child_spec/1
create/1
query_handle/0
update/1
wrap_qlc/1
Functions
get/3
get!/3
query_handle/0
wrap_qlc/2
.UserCache
Summary
Callbacks
bulk_create/1
child_spec/1
create/1
delete/1
query_handle/0
update/1
wrap_qlc/1
Functions
get/2
get!/1
query_handle/0
wrap_qlc/2
Structs
Nostrum.Struct
.ApplicationCommand
Summary
Types
application_command_edit_map/0
application_command_map/0
application_command_permission_type/0
application_command_permissions/0
command_choice/0
command_description/0
command_name/0
command_option/0
command_option_type/0
command_type/0
.ApplicationCommandInteractionData
Summary
Types
component_type/0
components/0
custom_id/0
id/0
interaction_type/0
name/0
options/0
resolved/0
select_values/0
t/0
target_id/0
.ApplicationCommandInteractionDataOption
Summary
Types
focused/0
name/0
options/0
t/0
type/0
value/0
.ApplicationCommandInteractionDataResolved
Summary
Types
attachments/0
channels/0
members/0
messages/0
roles/0
t/0
users/0
.AutoModerationRule
Summary
Types
actions/0
creator_id/0
enabled/0
event_type/0
exempt_channels/0
exempt_roles/0
guild_id/0
id/0
name/0
preset_values/0
t/0
trigger_metadata/0
trigger_type/0
.AutoModerationRule.Action
Summary
Types
action_type/0
metadata/0
t/0
.AutoModerationRule.ActionMetadata
Summary
Types
send_alert_message_metadata/0
t/0
timeout_metadata/0
.AutoModerationRule.TriggerMetadata
Summary
Types
keyword_metadata/0
preset_value_metadata/0
t/0
.Channel
Sections
Channel Struct
Channel Cache
Example
Helper Functions
Api Functions
Channel Types
Summary
Types
application_id/0
applied_tags/0
archive_timestamp/0
archived/0
auto_archive_duration/0
bitrate/0
channel_mention/0
default_auto_archive_duration/0
default_reaction_emoji/0
default_thread_rate_limit_per_user/0
dm_channel/0
flags/0
forum_tag/0
group_dm_channel/0
guild_category_channel/0
guild_channel/0
guild_forum_channel/0
guild_id/0
guild_news_channel/0
guild_news_thread_channel/0
guild_private_thread_channel/0
guild_public_thread_channel/0
guild_stage_voice_channel/0
guild_store_channel/0
guild_text_channel/0
guild_voice_channel/0
icon/0
id/0
join_timestamp/0
last_message_id/0
last_pin_timestamp/0
locked/0
member/0
member_count/0
message_count/0
name/0
newly_created/0
nsfw/0
owner_id/0
parent_id/0
permission_overwrites/0
permissions/0
position/0
rate_limit_per_user/0
recipients/0
rtc_region/0
t/0
text_channel/0
thread_metadata/0
topic/0
type/0
user_id/0
user_limit/0
video_quality_mode/0
voice_channel/0
Functions
mention/1
.Component
Sections
Action Row
Buttons
Link Buttons
Interaction Buttons ( Non-link Buttons )
🐼 Emoji Buttons
Select Menu
Text Input
Summary
Types
components/0
custom_id/0
disabled/0
emoji/0
label/0
max_length/0
max_values/0
min_length/0
min_values/0
options/0
placeholder/0
required/0
style/0
t/0
type/0
url/0
value/0
Callbacks
new/1
update/2
Functions
to_struct/1
.Component.ActionRow
Summary
Types
t/0
Functions
action_row/1
append/2
append_lazy/2
flatten/1
put/2
put_new/2
.Component.Button
Summary
Types
interaction_button/0
link_button/0
opt/0
opts/0
t/0
Functions
button/1
disable/2
flatten/1
interaction_button/3
link_button/3
put_style/2
toggle/1
.Component.Option
Summary
Types
default/0
description/0
emoji/0
label/0
t/0
value/0
.Component.SelectMenu
Summary
Types
opt/0
opts/0
t/0
Functions
flatten/1
select_menu/2
.Component.TextInput
Summary
Types
opt/0
opts/0
t/0
Functions
flatten/1
put_style/2
text_input/3
.Embed
Sections
Building Embeds
Using structs
Summary
Types
author/0
color/0
description/0
fields/0
footer/0
image/0
provider/0
t/0
thumbnail/0
timestamp/0
title/0
type/0
url/0
video/0
Callbacks
author/1
color/1
description/1
fields/1
footer/1
image/1
thumbnail/1
timestamp/1
title/1
url/1
Functions
from/1
put_author/4
put_color/2
put_description/2
put_field/4
put_footer/3
put_image/2
put_thumbnail/2
put_timestamp/2
put_title/2
put_url/2
.Embed.Author
Summary
Types
icon_url/0
name/0
proxy_icon_url/0
t/0
url/0
.Embed.Field
Summary
Types
inline/0
name/0
t/0
value/0
.Embed.Footer
Summary
Types
icon_url/0
proxy_icon_url/0
t/0
text/0
.Embed.Image
Summary
Types
height/0
proxy_url/0
t/0
url/0
width/0
.Embed.Provider
Summary
Types
name/0
t/0
url/0
.Embed.Thumbnail
Summary
Types
height/0
proxy_url/0
t/0
url/0
width/0
.Embed.Video
Summary
Types
height/0
t/0
url/0
width/0
.Emoji
Sections
Mentioning Emojis in Messages
Using Emojis in the Api
Summary
Types
animated/0
api_name/0
id/0
managed/0
name/0
require_colons/0
roles/0
t/0
user/0
Functions
api_name/1
image_url/1
mention/1
.Guild
Summary
Types
afk_channel_id/0
afk_timeout/0
application_id/0
available_guild/0
channels/0
default_message_notifications/0
emojis/0
explicit_content_filter/0
features/0
guild_scheduled_events/0
icon/0
id/0
joined_at/0
large/0
member_count/0
mfa_level/0
name/0
owner_id/0
public_updates_channel_id/0
region/0
rest_guild/0
roles/0
rules_channel_id/0
splash/0
system_channel_id/0
t/0
threads/0
unavailable/0
unavailable_guild/0
user_guild/0
vanity_url_code/0
verification_level/0
voice_states/0
widget_channel_id/0
widget_enabled/0
Functions
icon_url/2
splash_url/2
.Guild.AuditLog
Summary
Types
entries/0
t/0
users/0
webhooks/0
.Guild.AuditLogEntry
Summary
Types
action_type/0
changes/0
id/0
options/0
reason/0
t/0
target_id/0
user_id/0
.Guild.Ban
Summary
Types
reason/0
t/0
user/0
.Guild.Integration
Sections
References
Summary
Types
account/0
application/0
enabled/0
guild_id/0
id/0
name/0
t/0
type/0
.Guild.Integration.Account
Summary
Types
id/0
name/0
t/0
.Guild.Integration.Application
Summary
Types
bot/0
description/0
icon/0
id/0
name/0
summary/0
t/0
.Guild.Member
Sections
Mentioning Members in Messages
Summary
Types
communication_disabled_until/0
deaf/0
joined_at/0
mute/0
nick/0
premium_since/0
roles/0
t/0
user_id/0
Functions
guild_channel_permissions/3
guild_permissions/2
mention/1
top_role/2
.Guild.Role
Sections
Mentioning Roles in Messages
Summary
Types
color/0
hoist/0
icon/0
id/0
managed/0
mentionable/0
name/0
permissions/0
position/0
t/0
unicode_emoji/0
Functions
mention/1
.Guild.ScheduledEvent
Summary
Types
channel_id/0
creator/0
creator_id/0
description/0
entity_id/0
entity_metadata/0
entity_type/0
guild_id/0
id/0
name/0
privacy_level/0
scheduled_end_time/0
scheduled_start_time/0
status/0
t/0
user_count/0
Functions
to_struct/1
.Guild.ScheduledEvent.EntityMetadata
Summary
Types
location/0
t/0
.Guild.ScheduledEvent.User
Summary
Types
event_id/0
member/0
t/0
user/0
Functions
to_struct/1
.Guild.UnavailableGuild
Summary
Types
id/0
t/0
unavailable/0
Functions
to_struct/1
.Interaction
Summary
Types
application_id/0
channel/0
channel_id/0
data/0
guild_id/0
guild_locale/0
id/0
locale/0
member/0
message/0
t/0
token/0
type/0
user/0
version/0
.Invite
Summary
Types
approximate_member_count/0
approximate_presence_count/0
channel/0
code/0
created_at/0
detailed_invite/0
guild/0
inviter/0
max_age/0
max_uses/0
simple_invite/0
t/0
target_user/0
target_user_type/0
temporary/0
uses/0
.Message
Summary
Types
activity/0
application/0
application_id/0
attachments/0
author/0
channel_id/0
components/0
content/0
edited_timestamp/0
embeds/0
guild_id/0
id/0
interaction/0
member/0
mention_channels/0
mention_everyone/0
mention_roles/0
mentions/0
message_reference/0
nonce/0
pinned/0
reactions/0
referenced_message/0
sticker_items/0
t/0
thread/0
timestamp/0
tts/0
type/0
webhook_id/0
Functions
to_url/1
.Message.Activity
Summary
Types
party_id/0
t/0
type/0
.Message.Application
Summary
Types
cover_image/0
description/0
icon/0
id/0
name/0
t/0
.Message.Attachment
Summary
Types
filename/0
height/0
id/0
proxy_url/0
size/0
t/0
url/0
width/0
.Message.Component
Summary
Types
components/0
custom_id/0
disabled/0
emoji/0
label/0
max_length/0
max_values/0
min_length/0
min_values/0
options/0
placeholder/0
required/0
style/0
t/0
type/0
url/0
value/0
.Message.Reaction
Summary
Types
count/0
emoji/0
me/0
t/0
.Message.Reference
Summary
Types
channel_id/0
guild_id/0
message_id/0
t/0
.Message.Sticker
Summary
Types
available/0
description/0
format_type/0
guild_id/0
id/0
name/0
pack_id/0
sort_value/0
t/0
tags/0
type/0
user/0
.Overwrite
Summary
Types
allow/0
deny/0
id/0
t/0
type/0
.ThreadMember
Summary
Types
flags/0
guild_id/0
id/0
join_timestamp/0
t/0
user_id/0
.User
Sections
Mentioning Users in Messages
User vs. Member
Summary
Types
avatar/0
bot/0
discriminator/0
email/0
id/0
mfa_enabled/0
public_flags/0
t/0
username/0
verified/0
Functions
avatar_url/2
full_name/1
mention/1
.User.Connection
.User.Flags
Summary
Types
bug_hunter_level_1/0
bug_hunter_level_2/0
early_supporter/0
flags/0
hypesquad_balance/0
hypesquad_bravery/0
hypesquad_brilliance/0
hypesquad_events/0
partner/0
staff/0
system/0
t/0
team_user/0
verified_bot/0
verified_developer/0
Functions
from_integer/1
to_integer/1
.VoiceRegion
Summary
Types
t/0
.VoiceWSState
Summary
Types
channel_id/0
conn/0
conn_pid/0
gateway/0
guild_id/0
heartbeat_ack/0
heartbeat_interval/0
heartbeat_ref/0
identified/0
last_heartbeat_ack/0
last_heartbeat_send/0
secret_key/0
session/0
ssrc_map/0
stream/0
t/0
token/0
.WSState
Summary
Types
conn/0
conn_pid/0
gateway/0
heartbeat_ack/0
heartbeat_interval/0
heartbeat_ref/0
last_heartbeat_ack/0
last_heartbeat_send/0
seq/0
session/0
shard_num/0
shard_pid/0
stream/0
t/0
total_shards/0
zlib_ctx/0
.Webhook
Summary
Types
avatar/0
channel_id/0
guild_id/0
id/0
name/0
t/0
token/0
user/0
Nostrum.Struct.Event
.AutoModerationRuleExecute
Summary
Types
action/0
alert_system_message_id/0
channel_id/0
content/0
guild_id/0
matched_content/0
matched_keyword/0
message_id/0
rule_id/0
rule_trigger_type/0
t/0
user_id/0
.ChannelPinsUpdate
Summary
Types
channel_id/0
guild_id/0
last_pin_timestamp/0
t/0
.GuildBanAdd
Summary
Types
guild_id/0
t/0
user/0
.GuildBanRemove
Summary
Types
guild_id/0
t/0
user/0
.GuildIntegrationDelete
Summary
Types
application_id/0
guild_id/0
id/0
t/0
.GuildIntegrationsUpdate
Summary
Types
guild_id/0
t/0
.GuildScheduledEventUserAdd
Summary
Types
guild_id/0
guild_scheduled_event_id/0
t/0
user_id/0
.GuildScheduledEventUserRemove
Summary
Types
guild_id/0
guild_scheduled_event_id/0
t/0
user_id/0
.InviteCreate
Summary
Types
channel_id/0
code/0
created_at/0
guild_id/0
inviter/0
max_age/0
max_uses/0
t/0
target_user/0
target_user_type/0
temporary/0
uses/0
.InviteDelete
Summary
Types
channel_id/0
code/0
guild_id/0
t/0
.MessageDelete
Summary
Types
channel_id/0
guild_id/0
id/0
t/0
.MessageDeleteBulk
Summary
Types
channel_id/0
guild_id/0
ids/0
t/0
.MessageReactionAdd
Summary
Types
channel_id/0
emoji/0
guild_id/0
member/0
message_id/0
t/0
user_id/0
.MessageReactionRemove
Summary
Types
channel_id/0
emoji/0
guild_id/0
message_id/0
t/0
user_id/0
.MessageReactionRemoveAll
Summary
Types
channel_id/0
guild_id/0
message_id/0
t/0
.MessageReactionRemoveEmoji
Summary
Types
channel_id/0
emoji/0
guild_id/0
message_id/0
t/0
.PartialApplication
Summary
Types
flags/0
id/0
t/0
.Ready
Summary
Types
application/0
guilds/0
session_id/0
shard/0
t/0
user/0
v/0
.SpeakingUpdate
Summary
Types
channel_id/0
current_url/0
guild_id/0
speaking/0
t/0
timed_out/0
.ThreadListSync
Summary
Types
channel_ids/0
guid_id/0
members/0
t/0
threads/0
.ThreadMembersUpdate
Summary
Types
added_members/0
guild_id/0
id/0
member_count/0
removed_member_ids/0
t/0
.TypingStart
Summary
Types
channel_id/0
guild_id/0
member/0
t/0
timestamp/0
user_id/0
.VoiceReady
Summary
Types
channel_id/0
guild_id/0
t/0
.VoiceServerUpdate
Summary
Types
endpoint/0
guild_id/0
t/0
token/0
.VoiceState
Summary
Types
channel_id/0
deaf/0
guild_id/0
member/0
mute/0
request_to_speak_timestamp/0
self_deaf/0
self_mute/0
self_stream/0
self_video/0
session_id/0
suppress/0
t/0
user_id/0
Constants
Nostrum.Constants
.ApplicationCommandOptionType
Summary
Functions
attachment/0
boolean/0
channel/0
integer/0
mentionable/0
number/0
role/0
string/0
sub_command/0
sub_command_group/0
user/0
.ApplicationCommandPermissionType
Summary
Functions
channel/0
role/0
user/0
.ApplicationCommandType
Summary
Functions
chat_input/0
message/0
user/0
.ButtonStyle
Summary
Functions
danger/0
link/0
primary/0
secondary/0
success/0
.ChannelType
Summary
Functions
announcement_thread/0
dm/0
group_db/0
guild_announcement/0
guild_category/0
guild_directory/0
guild_forum/0
guild_text/0
guild_voice/0
private_thread/0
public_thread/0
.ComponentType
Summary
Functions
action_row/0
button/0
channel_select/0
mentionable_select/0
role_select/0
string_select/0
text_input/0
user_select/0
.InteractionCallbackType
Summary
Functions
application_command_autocomplete_result/0
channel_message_with_source/0
deferred_channel_message_with_source/0
deferred_update_message/0
modal/0
pong/0
update_message/0
.InteractionType
Summary
Functions
application_command/0
application_command_autocomplete/0
message_component/0
modal_submit/0
ping/0
.TextInputStyle
Summary
Functions
paragraph/0
short/0
.WebhookType
Summary
Functions
application/0
channel_follower/0
incoming/0
Utilities
Nostrum.Snowflake
Summary
Types
external_snowflake/0
t/0
Functions
cast/1
cast!/1
creation_time/1
dump/1
from_datetime/1
from_datetime!/1
is_snowflake/1
Nostrum.Token
Summary
Functions
check_token!/0
check_token!/1
Nostrum.Util
Summary
Functions
enum_to_struct/2
gateway/0
get_all_shard_latencies/0
get_shard_latency/1
maybe_to_atom/1
maybe_to_datetime/1
maybe_to_unixtime/1
now/0
now_iso/0
num_shards/0
safe_atom_map/1
unused_atoms/0
usec_now/0
Stores
Nostrum.Store
.GuildShardMapping
Sections
Purpose
Configuration
Summary
Callbacks
child_spec/1
create/2
delete/1
get/1
Functions
create/2
delete/1
get/1
.RatelimitBucket
Sections
Purpose
Configuration
Implementation
Summary
Types
bucket/0
latency/0
remaining/0
reset_time/0
route/0
Callbacks
child_spec/1
cleanup/1
lookup/1
update/2
update/4
Functions
cleanup/1
lookup/1
timeout_for/2
update/2
update/4
.Supervisor
Summary
Functions
child_spec/1
init/1
start_link/1
.UnavailableGuild
Sections
Purpose
Configuration
Implementation
Summary
Callbacks
child_spec/1
create/1
is?/1
Functions
create/1
is?/1
Pluggable caches & stores
Nostrum.Cache.ChannelCache
.ETS
Summary
Functions
child_spec/1
create/1
delete/1
init/1
query_handle/0
start_link/1
table/0
update/1
.Mnesia
Summary
Functions
child_spec/1
clear/0
create/1
delete/1
init/1
query_handle/0
start_link/1
table/0
teardown/0
update/1
wrap_qlc/1
Nostrum.Cache.ChannelGuildMapping
.ETS
Summary
Functions
child_spec/1
create/2
delete/1
get/1
init/1
start_link/1
table/0
.Mnesia
Summary
Functions
child_spec/1
create/2
delete/1
get/1
init/1
start_link/1
table/0
teardown/0
Nostrum.Cache.GuildCache
.ETS
Summary
Functions
channel_create/2
channel_delete/2
channel_update/2
child_spec/1
create/1
delete/1
emoji_update/2
init/1
member_count_down/1
member_count_up/1
query_handle/0
role_create/2
role_delete/2
role_update/2
start_link/1
tabname/0
update/1
voice_state_update/2
.Mnesia
Summary
Functions
channel_create/2
channel_delete/2
channel_update/2
child_spec/1
clear/0
create/1
delete/1
emoji_update/2
init/1
member_count_down/1
member_count_up/1
query_handle/0
role_create/2
role_delete/2
role_update/2
start_link/1
table/0
teardown/0
update/1
voice_state_update/2
wrap_qlc/1
.NoOp
Summary
Functions
child_spec/1
init/1
start_link/1
Nostrum.Cache.MemberCache
.ETS
Summary
Functions
bulk_create/2
child_spec/1
clear/0
create/2
delete/2
init/1
query_handle/0
start_link/1
table/0
update/2
wrap_qlc/1
.Mnesia
Summary
Functions
bulk_create/2
child_spec/1
clear/0
create/2
delete/2
init/1
query_handle/0
start_link/1
table/0
teardown/0
update/2
wrap_qlc/1
Nostrum.Cache.PresenceCache
.ETS
Summary
Functions
bulk_create/2
child_spec/1
create/1
init/1
query_handle/0
start_link/1
table/0
update/1
.Mnesia
Summary
Functions
bulk_create/2
child_spec/1
clear/0
create/1
init/1
query_handle/0
start_link/1
table/0
teardown/0
update/1
wrap_qlc/1
.NoOp
Summary
Functions
child_spec/1
init/1
start_link/1
Nostrum.Cache.UserCache
.ETS
Summary
Functions
bulk_create/1
child_spec/1
create/1
init/1
query_handle/0
start_link/1
table/0
update/1
.Mnesia
Summary
Functions
bulk_create/1
child_spec/1
clear/0
create/1
delete/1
init/1
query_handle/0
start_link/1
table/0
teardown/0
update/1
wrap_qlc/1
Nostrum.Store.GuildShardMapping
.ETS
Summary
Functions
child_spec/1
create/2
delete/1
get/1
init/1
start_link/1
table/0
.Mnesia
Summary
Functions
child_spec/1
create/2
delete/1
get/1
init/1
start_link/1
table/0
teardown/0
Nostrum.Store.RatelimitBucket
.ETS
Summary
Functions
child_spec/1
cleanup/1
init/1
lookup/1
start_link/1
table/0
update/2
update/4
.Mnesia
Summary
Functions
child_spec/1
cleanup/1
init/1
lookup/1
start_link/1
table/0
teardown/0
update/2
update/4
Nostrum.Store.UnavailableGuild
.ETS
Summary
Functions
child_spec/1
create/1
init/1
is?/1
start_link/1
table/0
.Mnesia
Summary
Functions
child_spec/1
create/1
init/1
is?/1
start_link/1
table/0
teardown/0
Internal modules
Nostrum.Shard.Supervisor
Sections
Implementation
Summary
Functions
child_spec/1
start_link/1
update_status/4
update_voice_state/4
Exceptions
Nostrum.Error.ApiError
Summary
Types
detailed_error/0
discord_status_code/0
error/0
error_list_map/0
errors/0
response/0
status_code/0
t/0
Nostrum.Error.CacheError
Nostrum.Error.VoiceError
Settings
View Source
Nostrum.Struct.User.Connection
(Nostrum v0.8.0)
Struct representing a Discord User's connections
×