interface AddGuildMemberOptions

export interface AddGuildMemberOptions

Options used to add a user to a guild using OAuth2.

accessToken : string

An OAuth2 access token for the user with the OAuth2Scopes.GuildsJoin scope granted to the bot's application

optional
deaf? : boolean

Whether the member should be deafened This property requires the PermissionFlagsBits.MuteMembers permission.

optional
fetchWhenExisting? : boolean

Whether to fetch the user if not cached and already a member (default: true)

optional
force? : boolean

Whether to skip the cache check and request the API directly

optional
mute? : boolean

Whether the member should be muted This property requires the PermissionFlagsBits.MuteMembers permission.

optional
nick? : string

The nickname to give to the member This property requires the PermissionFlagsBits.ManageNicknames permission.

optional
roles? : ReadonlyCollection<Snowflake, Role> | readonly RoleResolvable[]

The roles to add to the member This property requires the PermissionFlagsBits.ManageRoles permission.