Class GuildMemberManager

guild

me

• get me(): null | GuildMember

• Returns null | GuildMember

add

• add(user, options): Promise<null | GuildMember>

• Parameters

  • user: UserResolvable

  • options: AddGuildMemberOptions & {
        fetchWhenExisting: false;
    }

  Returns Promise<null | GuildMember>

• add(user, options): Promise<GuildMember>

• Parameters

  • user: UserResolvable

  • options: AddGuildMemberOptions

  Returns Promise<GuildMember>

addRole

• addRole(options): Promise<string | GuildMember | User>

• Parameters

  • options: AddOrRemoveGuildMemberRoleOptions

  Returns Promise<string | GuildMember | User>

ban

• ban(user, options?): Promise<string | GuildMember | User>

• Parameters

  • user: UserResolvable

  • Optional options: BanOptions

  Returns Promise<string | GuildMember | User>

bulkBan

• bulkBan(users, options?): Promise<BulkBanResult>

• Parameters

  • users: readonly UserResolvable[] | ReadonlyCollection<string, UserResolvable>

  • Optional options: BulkBanOptions

  Returns Promise<BulkBanResult>

edit

• edit(user, options): Promise<GuildMember>

• Parameters

  • user: UserResolvable

  • options: GuildMemberEditOptions

  Returns Promise<GuildMember>

fetch

• fetch(options): Promise<GuildMember>

• Parameters

  • options: UserResolvable | FetchMemberOptions | FetchMembersOptions & {
        user: UserResolvable;
    }

  Returns Promise<GuildMember>

• fetch(options?): Promise<Collection<string, GuildMember>>

• Parameters

  • Optional options: FetchMembersOptions

  Returns Promise<Collection<string, GuildMember>>

fetchMe

• fetchMe(options?): Promise<GuildMember>

• Parameters

  • Optional options: BaseFetchOptions

  Returns Promise<GuildMember>

kick

• kick(user, reason?): Promise<string | GuildMember | User>

• Parameters

  • user: UserResolvable

  • Optional reason: string

  Returns Promise<string | GuildMember | User>

list

• list(options?): Promise<Collection<string, GuildMember>>

• Parameters

  • Optional options: GuildListMembersOptions

  Returns Promise<Collection<string, GuildMember>>

prune

• prune(options): Promise<null>

• Parameters

  • options: GuildPruneMembersOptions & {
        count: false;
        dry?: false;
    }

  Returns Promise<null>

• prune(options?): Promise<number>

• Parameters

  • Optional options: GuildPruneMembersOptions

  Returns Promise<number>

removeRole

• removeRole(options): Promise<string | GuildMember | User>

• Parameters

  • options: AddOrRemoveGuildMemberRoleOptions

  Returns Promise<string | GuildMember | User>

search

• search(options): Promise<Collection<string, GuildMember>>

• Parameters

  • options: GuildSearchMembersOptions

  Returns Promise<Collection<string, GuildMember>>

unban

• unban(user, reason?): Promise<null | User>

• Parameters

  • user: UserResolvable

  • Optional reason: string

  Returns Promise<null | User>