Nostrum.Api.modify_current_user_nick
You're seeing just the function
modify_current_user_nick
, go back to Nostrum.Api module for more information.
Specs
modify_current_user_nick(Nostrum.Struct.Guild.id(), options()) :: error() | {:ok, %{nick: String.t()}}
Modifies the nickname of the current user in a guild.
If successful, returns {:ok, %{nick: nick}}
. Otherwise, returns a Nostrum.Api.error/0
.
Options
:nick
(string) - value to set users nickname to
Examples
Nostrum.Api.modify_current_user_nick(41771983423143937, nick: "Nostrum")
{:ok, %{nick: "Nostrum"}}