Alchemy.Client.add_member
You're seeing just the function
add_member
, go back to Alchemy.Client module for more information.
Link to this function
add_member(guild_id, user_id, access_token, options \\ [])
Specs
add_member(snowflake(), snowflake(), String.t(), nick: String.t(), roles: [snowflake()], mute: Boolean, deaf: Boolean, channel_id: snowflake() ) :: {:ok, nil} | {:error, term()}
Adds a member in a guild.
Each option requires different permissions.
Options
nick
The nickname of the user. Requires:manage_nicknames
roles
A list of roles (ids) the user should have after the change. Requires:manage_roles
mute
Whether or not the user should be muted. Requires:mute_members
deaf
Whether or not the user should be deafened. Requires:deafen_members
channel_id
Voice channel to move the user too (if they are connected). Requires:move_members
, and permission to connect to that channel.Examples
Client.add_member(guild_id, user_id, "abc123", nick: "cool guy")