Class GuildMemberManager

guild

me

• get me(): null | GuildMember

  Returns null | GuildMember

add

• add(
      user: UserResolvable,
      options: AddGuildMemberOptions & { fetchWhenExisting: false },
  ): Promise<null | GuildMember>

  Parameters

  • user: UserResolvable
  • options: AddGuildMemberOptions & { fetchWhenExisting: false }

  Returns Promise<null | GuildMember>

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

  Parameters

  • user: UserResolvable
  • options: AddGuildMemberOptions

  Returns Promise<GuildMember>

addRole

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

  Parameters

  • options: AddOrRemoveGuildMemberRoleOptions

  Returns Promise<string | User | GuildMember>

ban

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

  Parameters

  • user: UserResolvable
  • Optionaloptions: BanOptions

  Returns Promise<string | User | GuildMember>

bulkBan

• bulkBan(
      users:
          | readonly UserResolvable[]
          | ReadonlyCollection<string, UserResolvable>,
      options?: BulkBanOptions,
  ): Promise<BulkBanResult>

  Parameters

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

  Returns Promise<BulkBanResult>

edit

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

  Parameters

  • user: UserResolvable
  • options: GuildMemberEditOptions

  Returns Promise<GuildMember>

fetch

• fetch(
      options:
          | UserResolvable
          | FetchMemberOptions
          | FetchMembersOptions & { user: UserResolvable },
  ): Promise<GuildMember>

  Parameters

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

  Returns Promise<GuildMember>

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

  Parameters

  • Optionaloptions: FetchMembersOptions

  Returns Promise<Collection<string, GuildMember>>

fetchMe

• fetchMe(options?: BaseFetchOptions): Promise<GuildMember>

  Parameters

  • Optionaloptions: BaseFetchOptions

  Returns Promise<GuildMember>

kick

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

  Parameters

  • user: UserResolvable
  • Optionalreason: string

  Returns Promise<string | User | GuildMember>

list

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

  Parameters

  • Optionaloptions: GuildListMembersOptions

  Returns Promise<Collection<string, GuildMember>>

prune

• prune(
      options: GuildPruneMembersOptions & { count: false; dry?: false },
  ): Promise<null>

  Parameters

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

  Returns Promise<null>

• prune(options?: GuildPruneMembersOptions): Promise<number>

  Parameters

  • Optionaloptions: GuildPruneMembersOptions

  Returns Promise<number>

removeRole

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

  Parameters

  • options: AddOrRemoveGuildMemberRoleOptions

  Returns Promise<string | User | GuildMember>

search

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

  Parameters

  • options: GuildSearchMembersOptions

  Returns Promise<Collection<string, GuildMember>>

unban

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

  Parameters

  • user: UserResolvable
  • Optionalreason: string

  Returns Promise<null | User>