Class GuildMembersController

Provides an interface for a guild's members cache. The members are mapped by their IDs

Hierarchy

BaseFetchController<Member>
- GuildMembersController

Implements

BaseFetchSomeController<Member>

Index

Constructors

constructor

Properties

cache
guild

Accessors

me

Methods

Constructors

constructor

new GuildMembersController(guild: Guild): GuildMembersController

Overrides BaseController.constructor
- Defined in src/controllers/guild/GuildMembersController.ts:31
Parameters
- guild: Guild
Returns GuildMembersController

Properties

cache

cache: ControllerCache<Member>

The cached data this controller contains

Readonly guild

guild: Guild

The guild associated to this controller

Accessors

me

get me(): Member | undefined

- Defined in src/controllers/guild/GuildMembersController.ts:80
Returns the bot member in the guild

Returns Member | undefined

Methods

fetch

fetch(id: Snowflake): Promise<Member>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildMembersController.ts:44
Fetches a guild member and caches it

Parameters
- id: Snowflake
  
  The ID of the guild member
Returns Promise<Member>

fetchSome

fetchSome(options?: FetchSomeMembersOptions): Promise<Collection<Snowflake, Member>>

- Defined in src/controllers/guild/GuildMembersController.ts:57
Fetches some guild members in this guild and caches them

Parameters
- Optional options: FetchSomeMembersOptions
  
  The options for the fetch operation
Returns Promise<Collection<Snowflake, Member>>

get

get(id: Snowflake | string): Promise<Member>

Inherited from BaseFetchController.get
- Defined in src/controllers/base/BaseFetchController.ts:22
Returns an already cached item or fetches it

Parameters
- id: Snowflake | string
  
  The ID of the item you wish to get or fetch
Returns Promise<Member>

remove

remove(id: Snowflake): Promise<void>

- Defined in src/controllers/guild/GuildMembersController.ts:72
Removes a user from this guild by its user ID

Parameters
- id: Snowflake
  
  The ID of the user
Returns Promise<void>

Generated using TypeDoc