Class GuildMemberManager

Manages API methods for GuildMembers

Hierarchy

GuildMemberManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GuildMemberManager(client: Client, guild: Guild): GuildMemberManager

- Defined in src/managers/GuildMemberManager.ts:29
Parameters
- client: Client
- guild: Guild
Returns GuildMemberManager

Properties

cache

cache: LimitedCollection<string, GuildMember>

All of the members the client is currently handling in this guild, mapped by their Ids

client

client: Client

The client that instantiated this Manager

guild

guild: Guild

The Guild belonging to this manager

Methods

Private #fetchAll

#fetchAll(options: GatewayRequestGuildMembersData): Promise<Collection<string, GuildMember>>

- Defined in src/managers/GuildMemberManager.ts:141
Parameters
- options: GatewayRequestGuildMembersData
Returns Promise<Collection<string, GuildMember>>

ban

ban(id: string, options?: BanOptions): Promise<GuildBan>

- Defined in src/managers/GuildMemberManager.ts:119
Bans a user from the guild
example
```
guild.members.ban('123456789123456')
```
example
```
guild.members.ban('123456789123456', { reason: 'Spamming', days: 1 })
```
Parameters
- id: string
- options: BanOptions = ...
  
  Options for the ban
Returns Promise<GuildBan>

edit

edit(userId: string, data: GuildMemberEditData, reason?: string): Promise<GuildMember>

- Defined in src/managers/GuildMemberManager.ts:49
Edits a guild member
example
```
guild.members.edit('12345678901234567', { roles: ['12345678901234567'] })
```
example
```
guild.members.edit('12345678901234567', { nick: 'Veric', roles: ['2345678954234590'] })
```
Parameters
- userId: string
  
  The Id of the user to edit
- data: GuildMemberEditData
  
  The data to edit the member with
- reason: string = ''
  
  The reason for editing the member
Returns Promise<GuildMember>

fetch

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

- Defined in src/managers/GuildMemberManager.ts:86
Fetches member(s) from this guild, even if they're offline

Parameters
- id: string
Returns Promise<GuildMember>
- Defined in src/managers/GuildMemberManager.ts:87
Parameters
- Optional id: string
Returns Promise<Collection<string, GuildMember>>

kick

kick(userId: string, reason?: string): Promise<undefined>

- Defined in src/managers/GuildMemberManager.ts:101
Kicks a user from the guild

Parameters
- userId: string
  
  The member to kick
- reason: string = ''
  
  Reason for kicking
Returns Promise<undefined>

search

search(query?: string, limit?: number): Promise<Collection<string, GuildMember>>

- Defined in src/managers/GuildMemberManager.ts:69
Searches member(s) from this guild
example
```
guild.members.search('Bob', 10)
```
Parameters
- query: string = ''
  
  Query string to match username(s) and nickname(s) against
- limit: number = 100
  
  Max number of members to return (1-1000). Default: 100
Returns Promise<Collection<string, GuildMember>>

unban

unban(id: string, reason?: string): Promise<undefined | User>

- Defined in src/managers/GuildMemberManager.ts:136
Unbans a user from the guild
example
```
guild.members.ban('123456789123456')
```
- @example
```
guild.bans.remove('123456789123456', 'Applied ban in the wrong user')
```
Parameters
- id: string
- reason: string = ''
  
  Reason for unbanning
Returns Promise<undefined | User>

Private updateOrSet

updateOrSet(id: string, data: APIGuildMember): GuildMember

- Defined in src/managers/GuildMemberManager.ts:172
Updates or caches a Guild with the provided APIGuild data

Parameters
- id: string
- data: APIGuildMember
Returns GuildMember

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM