AddGuildMemberOptions

typedef · Source

Options used to add a user to a guild using OAuth2. Type: Object

Properties

accessToken

accessToken: string

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

nick

optional

nick: string

The nickname to give to the member (requires MANAGE_NICKNAMES)

roles

optional

roles: Collection<Snowflake, Role> | Array<RoleResolvable>

The roles to add to the member (requires MANAGE_ROLES)

mute

optional

mute: boolean

Whether the member should be muted (requires MUTE_MEMBERS)

deaf

optional

deaf: boolean

Whether the member should be deafened (requires DEAFEN_MEMBERS)

force

optional

force: boolean

Whether to skip the cache check and call the API directly

fetchWhenExisting

optional

fetchWhenExisting: boolean

Whether to fetch the user if not cached and already a member

Default: true