Class GuildMemberManager

Hierarchy

BaseManager<GuildMember>
- GuildMemberManager

Index

Constructors

constructor

Properties

Accessors

size

Methods

Constructors

constructor

new GuildMemberManager(client: Client, guildId: string): GuildMemberManager

Overrides BaseManager.constructor
- Defined in src/structures/managers/GuildMemberManager.ts:13
Parameters
- client: Client
- guildId: string
Returns GuildMemberManager

Properties

__class

__class: any

cache

cache: Map<string, GuildMember> = ...

client

client: Client

guildId

guildId: string

Accessors

size

get size(): number

Inherited from BaseManager.size
- Defined in src/structures/managers/BaseManager.ts:9
Returns number

Methods

add

add(data: GuildMember): GuildMember

Inherited from BaseManager.add
- Defined in src/structures/managers/BaseManager.ts:26
Parameters
- data: GuildMember
Returns GuildMember

addMany

addMany(data: GuildMember[]): GuildMember[]

Inherited from BaseManager.addMany
- Defined in src/structures/managers/BaseManager.ts:31
Parameters
- data: GuildMember[]
Returns GuildMember[]

ban

ban(member: string | GuildMember, __namedParameters?: BanGuildMemberOptions): Promise<void>

- Defined in src/structures/managers/GuildMemberManager.ts:67
Parameters
- member: string | GuildMember
- __namedParameters: BanGuildMemberOptions = {}
Returns Promise<void>

create

create(id: string, token: string, __namedParameters?: AddGuildMemberOptions): Promise<GuildMember>

- Defined in src/structures/managers/GuildMemberManager.ts:95
Add a guild member to the guild using an OAuth2 access token. The access token requires the guilds.join scope.

Parameters
- id: string
- token: string
- __namedParameters: AddGuildMemberOptions = {}
Returns Promise<GuildMember>

disableCommunicationFor

disableCommunicationFor(member: string | GuildMember, until: number | Date, reason?: string): Promise<GuildMember>

- Defined in src/structures/managers/GuildMemberManager.ts:57
Parameters
- member: string | GuildMember
- until: number | Date
- Optional reason: string
Returns Promise<GuildMember>

fetch

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

Overrides BaseManager.fetch
- Defined in src/structures/managers/GuildMemberManager.ts:17
Parameters
- Optional id: string
Returns Promise<GuildMember>

get

get(id: string): undefined | GuildMember

Inherited from BaseManager.get
- Defined in src/structures/managers/BaseManager.ts:22
Parameters
- id: string
Returns undefined | GuildMember

map

map(fn: (data: GuildMember, key: string, cache: Map<string, GuildMember>) => any): any[]

Inherited from BaseManager.map
- Defined in src/structures/managers/BaseManager.ts:53
Parameters
- fn: (data: GuildMember, key: string, cache: Map<string, GuildMember>) => any
  - - (data: GuildMember, key: string, cache: Map<string, GuildMember>): any
    - Parameters
      - data: GuildMember
      - key: string
      - cache: Map<string, GuildMember>
      Returns any
Returns any[]

remove

remove(id: string): void

Inherited from BaseManager.remove
- Defined in src/structures/managers/BaseManager.ts:49
Parameters
- id: string
Returns void

removeMany

removeMany(ids: string[]): void

Inherited from BaseManager.removeMany
- Defined in src/structures/managers/BaseManager.ts:38
Parameters
- ids: string[]
Returns void

resolve

resolve(data: any): undefined | GuildMember

Inherited from BaseManager.resolve
- Defined in src/structures/managers/BaseManager.ts:59
Parameters
- data: any
Returns undefined | GuildMember

unban

unban(id: string, reason?: string): Promise<void>

- Defined in src/structures/managers/GuildMemberManager.ts:84
Parameters
- id: string
- Optional reason: string
Returns Promise<void>

update

update(data: GuildMember): GuildMember

Inherited from BaseManager.update
- Defined in src/structures/managers/BaseManager.ts:44
Parameters
- data: GuildMember
Returns GuildMember

Generated using TypeDoc