View Source Nostrum.Api (Nostrum v0.10.4)
Interface for Discord's rest API.
By default all methods in this module are ran synchronously. If you wish to have async rest operations I recommend you execute these functions inside of a task.
Examples
# Async Task
t = Task.async fn ->
Nostrum.Api.Channel.messages(12345678912345, :infinity, {})
end
messages = Task.await t
# A lot of times we don't care about the return value of the function
Task.start fn ->
messages = ["in", "the", "end", "it", "doesn't", "even", "matter"]
Enum.each messages, &Nostrum.Api.Message.create(12345678912345, &1)
endA note about Strings and Ints
Currently, responses from the REST api will have id fields as string.
Everything received from the WS connection will have id fields as int.
If you're processing a response from the API and trying to access something in the cache
based off of an id in the response, you will need to convert it to an int using
String.to_integer/1. I'm open to suggestions for how this should be handled going forward.
Example
messages = Nostrum.Api.Channel.pinned_messages!(12345678912345)
authors =
Enum.map messages, fn msg ->
author_id = String.to_integer(msg.author.id)
Nostrum.Cache.User.get!(id: author_id)
endSummary
Types
Represents which mentions to allow in a message.
Represents mentions to allow in a message.
Represents an emoji for interacting with reaction endpoints.
Represents a failed response from the API.
Represents a limit used to retrieve messages.
Represents a tuple used to locate messages.
Represents optional parameters for Api functions.
Represents different statuses the bot can have.
Functions
Same as add_guild_member/3, but raises Nostrum.Error.ApiError in case of failure.
Same as add_pinned_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as begin_guild_prune/2, but raises Nostrum.Error.ApiError in case of failure.
Same as bulk_delete_messages/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_channel_invite/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_dm/1, but raises Nostrum.Error.ApiError in case of failure.
Same as create_followup_message/3, but raises Nostrum.Error.ApiError in case of failure.
Same as create_group_dm/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_guild_channel/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_guild_role/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
Same as create_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as create_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_all_reactions/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_channel/1, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_guild/1, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_guild_role/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_interaction_followup_message/3, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
Same as delete_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_invite/1, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_message/2, but takes a Nostrum.Struct.Message instead of a
channel_id and message_id.
Same as delete_message/1, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_own_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_pinned_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
Same as delete_user_reaction/4, but raises Nostrum.Error.ApiError in case of failure.
Same as edit_channel_permissions/3, but raises Nostrum.Error.ApiError in case of failure.
Same as edit_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
Same as edit_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
Same as edit_interaction_response/3, but raises Nostrum.Error.ApiError in case of failure.
Same as edit_message/3, but takes a Nostrum.Struct.Message instead of a
channel_id and message_id.
Same as edit_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as edit_message/3, but raises Nostrum.Error.ApiError in case of failure.
Same as expire_poll/2, but raises Nostrum.Error.ApiError in case of failure.
Same as get_channel/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_channel_invites/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
Same as get_channel_messages/3, but raises Nostrum.Error.ApiError in case of failure.
Same as get_current_user/0, but raises Nostrum.Error.ApiError in case of failure.
Same as get_current_user_guilds/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_channels/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_invites/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_member/2, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_prune_count/2, but raises Nostrum.Error.ApiError in case of failure.
Same as get_guild_roles/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_invite/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_pinned_messages/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_poll_answer_voters/4, but raises Nostrum.Error.ApiError in case of failure.
Same as get_reactions/4, but raises Nostrum.Error.ApiError in case of failure.
Same as get_user/1, but raises Nostrum.Error.ApiError in case of failure.
Same as get_user_dms/0, but raises Nostrum.Error.ApiError in case of failure.
Same as list_guild_emojis/1, but raises Nostrum.Error.ApiError in case of failure.
Same as list_guild_members/2, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_channel/2, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_current_user/1, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_current_user_nick/2, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild/2, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild_channel_positions/2, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild_emoji/3, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild_member/3, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild_role/3, but raises Nostrum.Error.ApiError in case of failure.
Same as modify_guild_role_positions/2, but raises Nostrum.Error.ApiError in case of failure.
Same as remove_guild_member/2, but raises Nostrum.Error.ApiError in case of failure.
Same as start_typing/1, but raises Nostrum.Error.ApiError in case of failure.
Types
@type allowed_mention() :: :all | :none | :everyone | :users | :roles | {:users, [Nostrum.Struct.User.id()]} | {:roles, [Nostrum.Struct.Guild.Role.id()]}
Represents which mentions to allow in a message.
This can be sent on its own or in a list to allow multiple types of
mentions in a message, see allowed_mentions/0 for details.
@type allowed_mentions() :: allowed_mention() | [allowed_mention()]
Represents mentions to allow in a message.
With this option you can control when content from a message should trigger a ping. Consider using this option when you are going to display user generated content.
Allowed values
:all(default) - Ping everything as usual:none- Nobody will be pinged:everyone- Allows to ping @here and @everyone:users- Allows to ping users:roles- Allows to ping roles{:users, list}- Allows to ping list of users. Can contain up to 100 ids of users.{:roles, list}- Allows to ping list of roles. Can contain up to 100 ids of roles.- list - a list containing the values above.
@type emoji() :: Nostrum.Struct.Emoji.t() | Nostrum.Struct.Emoji.api_name()
Represents an emoji for interacting with reaction endpoints.
@type error() :: {:error, Nostrum.Error.ApiError.t()}
Represents a failed response from the API.
This occurs when :gun fails, or when the API doesn't respond with 200 or 204.
@type limit() :: integer() | :infinity
Represents a limit used to retrieve messages.
Integer number of messages, or :infinity to retrieve all messages.
Represents a tuple used to locate messages.
The first element of the tuple is an atom. The second element will be a message_id as an integer. The tuple can also be empty to search from the most recent message in the channel
Represents optional parameters for Api functions.
Each function has documentation regarding what parameters it supports or needs.
@type status() :: :dnd | :idle | :online | :invisible
Represents different statuses the bot can have.
:dnd- Red circle.:idle- Yellow circle.:online- Green circle.:invisible- The bot will appear offline.
Functions
@spec add_guild_member!( Nostrum.Struct.Guild.id(), Nostrum.Struct.User.id(), options() ) :: no_return() | Nostrum.Struct.Guild.Member.t() | {:ok}
Same as add_guild_member/3, but raises Nostrum.Error.ApiError in case of failure.
@spec add_pinned_channel_message!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id() ) :: no_return() | {:ok}
Same as add_pinned_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
batch_edit_application_command_permissions(application_id \\ Me.get().id, guild_id, permissions)
View SourceSee Nostrum.Api.ApplicationCommand.batch_edit_permissions/3.
@spec begin_guild_prune!( Nostrum.Struct.Guild.id(), 1..30, Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | %{pruned: integer()}
Same as begin_guild_prune/2, but raises Nostrum.Error.ApiError in case of failure.
@spec bulk_delete_messages!(integer(), [Nostrum.Struct.Message.id()], boolean()) :: no_return() | {:ok}
Same as bulk_delete_messages/2, but raises Nostrum.Error.ApiError in case of failure.
bulk_overwrite_global_application_commands(application_id \\ Me.get().id, commands)
View SourceSee Nostrum.Api.ApplicationCommand.bulk_overwrite_global_commands/2.
bulk_overwrite_guild_application_commands(application_id \\ Me.get().id, guild_id, commands)
View SourceSee Nostrum.Api.ApplicationCommand.bulk_overwrite_guild_commands/3.
@spec create_channel_invite!( Nostrum.Struct.Channel.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Invite.detailed_invite()
Same as create_channel_invite/2, but raises Nostrum.Error.ApiError in case of failure.
@spec create_dm!(Nostrum.Struct.User.id()) :: no_return() | Nostrum.Struct.Channel.dm_channel()
Same as create_dm/1, but raises Nostrum.Error.ApiError in case of failure.
create_file_part_for_multipart(file, index, boundary, name_override \\ nil)
View Sourcecreate_followup_message(application_id \\ Me.get().id, token, webhook_payload)
View Sourcecreate_followup_message!(application_id \\ Me.get().id, token, webhook_payload)
View Source (since 0.5.0)@spec create_followup_message!( Nostrum.Struct.User.id(), Nostrum.Struct.Interaction.token(), map() ) :: no_return() | Nostrum.Struct.Message.t()
Same as create_followup_message/3, but raises Nostrum.Error.ApiError in case of failure.
create_global_application_command(application_id \\ Me.get().id, command)
View Source@spec create_group_dm!([String.t()], %{ optional(Nostrum.Struct.User.id()) => String.t() }) :: no_return() | Nostrum.Struct.Channel.group_dm_channel()
Same as create_group_dm/2, but raises Nostrum.Error.ApiError in case of failure.
create_guild_application_command(application_id \\ Me.get().id, guild_id, command)
View Sourcecreate_guild_ban(guild_id, user_id, days_to_delete, reason \\ nil)
View Source@spec create_guild_channel!(Nostrum.Struct.Guild.id(), options()) :: no_return() | Nostrum.Struct.Channel.guild_channel()
Same as create_guild_channel/2, but raises Nostrum.Error.ApiError in case of failure.
@spec create_guild_emoji!( Nostrum.Struct.Guild.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Emoji.t()
Same as create_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
@spec create_guild_role!( Nostrum.Struct.Guild.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Guild.Role.t()
Same as create_guild_role/2, but raises Nostrum.Error.ApiError in case of failure.
create_guild_sticker(guild_id, name, description, tags, file, reason \\ nil)
View Source@spec create_interaction_response(Nostrum.Struct.Interaction.t(), map()) :: {:ok} | error()
Same as create_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
@spec create_interaction_response!(Nostrum.Struct.Interaction.t(), map()) :: no_return() | {:ok}
Same as create_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
@spec create_message!( Nostrum.Struct.Channel.id() | Nostrum.Struct.Message.t(), options() | String.t() ) :: no_return() | Nostrum.Struct.Message.t()
Same as create_message/2, but raises Nostrum.Error.ApiError in case of failure.
@spec create_reaction!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), emoji() ) :: no_return() | {:ok}
Same as create_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_all_reactions!(Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id()) :: no_return() | {:ok}
Same as delete_all_reactions/2, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_channel!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Channel.t()
Same as delete_channel/1, but raises Nostrum.Error.ApiError in case of failure.
delete_channel_permissions(channel_id, overwrite_id, reason \\ nil)
View Sourcedelete_global_application_command(application_id \\ Me.get().id, command_id)
View Source@spec delete_guild!(Nostrum.Struct.Guild.id()) :: no_return() | {:ok}
Same as delete_guild/1, but raises Nostrum.Error.ApiError in case of failure.
delete_guild_application_command(application_id \\ Me.get().id, guild_id, command_id)
View Source@spec delete_guild_emoji!( Nostrum.Struct.Guild.id(), Nostrum.Struct.Emoji.id(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | {:ok}
Same as delete_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_guild_role!( Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.id(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | {:ok}
Same as delete_guild_role/2, but raises Nostrum.Error.ApiError in case of failure.
delete_interaction_followup_message(application_id \\ Me.get().id, token, message_id)
View Sourcedelete_interaction_followup_message!(application_id \\ Me.get().id, token, message_id)
View Source (since 0.5.0)@spec delete_interaction_followup_message!( Nostrum.Struct.User.id(), Nostrum.Struct.Interaction.token(), Nostrum.Struct.Message.id() ) :: no_return() | {:ok}
Same as delete_interaction_followup_message/3, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_interaction_response(Nostrum.Struct.Interaction.t()) :: {:ok} | error()
Same as delete_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
@spec delete_interaction_response!(Nostrum.Struct.Interaction.t()) :: no_return() | {:ok}
delete_interaction_response!(id \\ Me.get().id, token)
View Source (since 0.5.0)@spec delete_interaction_response!( Nostrum.Struct.User.id(), Nostrum.Struct.Interaction.token() ) :: no_return() | {:ok}
Same as delete_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_invite!(Nostrum.Struct.Invite.code()) :: no_return() | Nostrum.Struct.Invite.simple_invite()
Same as delete_invite/1, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_message(Nostrum.Struct.Message.t()) :: error() | {:ok}
Same as delete_message/2, but takes a Nostrum.Struct.Message instead of a
channel_id and message_id.
@spec delete_message!(Nostrum.Struct.Message.t()) :: error() | {:ok}
Same as delete_message/1, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_message!(Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id()) :: no_return() | {:ok}
Same as delete_message/2, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_own_reaction!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), emoji() ) :: no_return() | {:ok}
Same as delete_own_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_pinned_channel_message!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id() ) :: no_return() | {:ok}
Same as delete_pinned_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_reaction!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), emoji() ) :: no_return() | {:ok}
Same as delete_reaction/3, but raises Nostrum.Error.ApiError in case of failure.
@spec delete_user_reaction!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), emoji(), Nostrum.Struct.User.id() ) :: no_return() | {:ok}
Same as delete_user_reaction/4, but raises Nostrum.Error.ApiError in case of failure.
edit_application_command_permissions(application_id \\ Me.get().id, guild_id, command_id, permissions)
View SourceSee Nostrum.Api.ApplicationCommand.edit_command_permissions/4.
edit_channel_permissions(channel_id, overwrite_id, permission_info, reason \\ nil)
View Sourceedit_channel_permissions!(channel_id, overwrite_id, permission_info, reason \\ nil)
View Source@spec edit_channel_permissions!( integer(), integer(), %{ :type => String.t(), optional(:allow) => integer(), optional(:deny) => integer() }, Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | {:ok}
Same as edit_channel_permissions/3, but raises Nostrum.Error.ApiError in case of failure.
edit_global_application_command(application_id \\ Me.get().id, command_id, command)
View Sourceedit_guild_application_command(application_id \\ Me.get().id, guild_id, command_id, command)
View Source@spec edit_interaction_response(Nostrum.Struct.Interaction.t(), map()) :: {:ok, Nostrum.Struct.Message.t()} | error()
Same as edit_interaction_response/3, but directly takes the
Nostrum.Struct.Interaction.t/0 received from the gateway.
@spec edit_interaction_response!(Nostrum.Struct.Interaction.t(), map()) :: no_return() | Nostrum.Struct.Message.t()
Same as edit_interaction_response/2, but raises Nostrum.Error.ApiError in case of failure.
edit_interaction_response!(id \\ Me.get().id, token, response)
View Source (since 0.5.0)@spec edit_interaction_response!( Nostrum.Struct.User.id(), Nostrum.Struct.Interaction.token(), map() ) :: no_return() | Nostrum.Struct.Message.t()
Same as edit_interaction_response/3, but raises Nostrum.Error.ApiError in case of failure.
@spec edit_message(Nostrum.Struct.Message.t(), options()) :: error() | {:ok, Nostrum.Struct.Message.t()}
Same as edit_message/3, but takes a Nostrum.Struct.Message instead of a
channel_id and message_id.
@spec edit_message!(Nostrum.Struct.Message.t(), options()) :: no_return() | Nostrum.Struct.Message.t()
Same as edit_message/2, but raises Nostrum.Error.ApiError in case of failure.
@spec edit_message!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), options() ) :: no_return() | Nostrum.Struct.Message.t()
Same as edit_message/3, but raises Nostrum.Error.ApiError in case of failure.
@spec expire_poll!(Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id()) :: Nostrum.Struct.Message.t()
Same as expire_poll/2, but raises Nostrum.Error.ApiError in case of failure.
get_application_command_permissions(application_id \\ Me.get().id, guild_id, command_id)
View Source@spec get_channel!(Nostrum.Struct.Channel.id()) :: no_return() | Nostrum.Struct.Channel.t()
Same as get_channel/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_channel_invites!(Nostrum.Struct.Channel.id()) :: no_return() | [Nostrum.Struct.Invite.detailed_invite()]
Same as get_channel_invites/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_channel_message!(Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id()) :: no_return() | Nostrum.Struct.Message.t()
Same as get_channel_message/2, but raises Nostrum.Error.ApiError in case of failure.
@spec get_channel_messages!(Nostrum.Struct.Channel.id(), limit(), locator()) :: no_return() | [Nostrum.Struct.Message.t()]
Same as get_channel_messages/3, but raises Nostrum.Error.ApiError in case of failure.
@spec get_current_user!() :: no_return() | Nostrum.Struct.User.t()
Same as get_current_user/0, but raises Nostrum.Error.ApiError in case of failure.
@spec get_current_user_guilds!(options()) :: no_return() | [Nostrum.Struct.Guild.user_guild()]
Same as get_current_user_guilds/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild!(Nostrum.Struct.Guild.id()) :: no_return() | Nostrum.Struct.Guild.rest_guild()
Same as get_guild/1, but raises Nostrum.Error.ApiError in case of failure.
get_guild_application_command_permissions(application_id \\ Me.get().id, guild_id)
View Sourceget_guild_application_commands(application_id \\ Me.get().id, guild_id)
View Source@spec get_guild_channels!(Nostrum.Struct.Guild.id()) :: no_return() | [Nostrum.Struct.Channel.guild_channel()]
Same as get_guild_channels/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild_emoji!(Nostrum.Struct.Guild.id(), Nostrum.Struct.Emoji.id()) :: no_return() | Nostrum.Struct.Emoji.t()
Same as get_guild_emoji/2, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild_invites!(Nostrum.Struct.Guild.id()) :: no_return() | [Nostrum.Struct.Invite.detailed_invite()]
Same as get_guild_invites/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild_member!(Nostrum.Struct.Guild.id(), Nostrum.Struct.User.id()) :: no_return() | Nostrum.Struct.Guild.Member.t()
Same as get_guild_member/2, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild_prune_count!(Nostrum.Struct.Guild.id(), 1..30) :: no_return() | %{pruned: integer()}
Same as get_guild_prune_count/2, but raises Nostrum.Error.ApiError in case of failure.
@spec get_guild_roles!(Nostrum.Struct.Guild.id()) :: no_return() | [Nostrum.Struct.Guild.Role.t()]
Same as get_guild_roles/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_invite!(Nostrum.Struct.Invite.code(), options()) :: no_return() | Nostrum.Struct.Invite.simple_invite()
Same as get_invite/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_pinned_messages!(Nostrum.Struct.Channel.id()) :: no_return() | [Nostrum.Struct.Message.t()]
Same as get_pinned_messages/1, but raises Nostrum.Error.ApiError in case of failure.
get_poll_answer_voters(channel_id, message_id, answer_id, params \\ [])
View Sourceget_poll_answer_voters!(channel_id, message_id, answer_id, params \\ [])
View SourceSame as get_poll_answer_voters/4, but raises Nostrum.Error.ApiError in case of failure.
@spec get_reactions!( Nostrum.Struct.Channel.id(), Nostrum.Struct.Message.id(), emoji(), keyword() ) :: no_return() | [Nostrum.Struct.User.t()]
Same as get_reactions/4, but raises Nostrum.Error.ApiError in case of failure.
@spec get_user!(Nostrum.Struct.User.id()) :: no_return() | Nostrum.Struct.User.t()
Same as get_user/1, but raises Nostrum.Error.ApiError in case of failure.
@spec get_user_dms!() :: no_return() | [Nostrum.Struct.Channel.dm_channel()]
Same as get_user_dms/0, but raises Nostrum.Error.ApiError in case of failure.
@spec list_guild_emojis!(Nostrum.Struct.Guild.id()) :: no_return() | [Nostrum.Struct.Emoji.t()]
Same as list_guild_emojis/1, but raises Nostrum.Error.ApiError in case of failure.
@spec list_guild_members!(Nostrum.Struct.Guild.id(), options()) :: no_return() | [Nostrum.Struct.Guild.Member.t()]
Same as list_guild_members/2, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_channel!( Nostrum.Struct.Channel.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Channel.t()
Same as modify_channel/2, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_current_user!(options()) :: no_return() | Nostrum.Struct.User.t()
Same as modify_current_user/1, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_current_user_nick!(Nostrum.Struct.Guild.id(), options()) :: no_return() | %{nick: String.t()}
Same as modify_current_user_nick/2, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_guild!(Nostrum.Struct.Guild.id(), options()) :: no_return() | Nostrum.Struct.Guild.rest_guild()
Same as modify_guild/2, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_guild_channel_positions!(Nostrum.Struct.Guild.id(), [ %{id: integer(), position: integer()} ]) :: no_return() | {:ok}
Same as modify_guild_channel_positions/2, but raises Nostrum.Error.ApiError in case of failure.
modify_guild_emoji(guild_id, emoji_id, options \\ %{}, reason \\ nil)
View Source@spec modify_guild_emoji!( Nostrum.Struct.Guild.id(), Nostrum.Struct.Emoji.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Emoji.t()
Same as modify_guild_emoji/3, but raises Nostrum.Error.ApiError in case of failure.
modify_guild_member(guild_id, user_id, options \\ %{}, reason \\ nil)
View Sourcemodify_guild_member!(guild_id, user_id, options \\ %{}, reason \\ nil)
View Source@spec modify_guild_member!( Nostrum.Struct.Guild.id(), Nostrum.Struct.User.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: error() | {:ok}
Same as modify_guild_member/3, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_guild_role!( Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.id(), options(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | Nostrum.Struct.Guild.Role.t()
Same as modify_guild_role/3, but raises Nostrum.Error.ApiError in case of failure.
@spec modify_guild_role_positions!( Nostrum.Struct.Guild.id(), [%{id: Nostrum.Struct.Guild.Role.id(), position: integer()}], Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | [Nostrum.Struct.Guild.Role.t()]
Same as modify_guild_role_positions/2, but raises Nostrum.Error.ApiError in case of failure.
modify_guild_scheduled_event(guild_id, event_id, reason \\ nil, options)
View Sourcemodify_webhook_with_token(webhook_id, webhook_token, args, reason \\ nil)
View Source@spec remove_guild_member!( Nostrum.Struct.Guild.id(), Nostrum.Struct.User.id(), Nostrum.Struct.Guild.AuditLogEntry.reason() ) :: no_return() | {:ok}
Same as remove_guild_member/2, but raises Nostrum.Error.ApiError in case of failure.
remove_guild_member_role(guild_id, user_id, role_id, reason \\ nil)
View Sourcestart_thread_with_message(channel_id, message_id, options, reason \\ nil)
View SourceSame as start_typing/1, but raises Nostrum.Error.ApiError in case of failure.