GuildMemberManager
Defined in: packages/managers/src/member.ts:25
Manages Discord guild members.
Extends
Section titled “Extends”ResourceManager<string,GuildMember>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuildMemberManager(
guildId,rest,context?,maxSize?):GuildMemberManager
Defined in: packages/managers/src/member.ts:31
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
context?
Section titled “context?”() => ResourceContext | undefined
Gives fetched members their actions (member.kick()…).
maxSize?
Section titled “maxSize?”number
Returns
Section titled “Returns”GuildMemberManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,GuildMember>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/managers/src/member.ts:28
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,GuildMember]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, GuildMember]>
Cache iterator.
Inherited from
Section titled “Inherited from”addRole()
Section titled “addRole()”addRole(
userId,roleId,reason?):Promise<void>
Defined in: packages/managers/src/member.ts:141
Adds a role to a member.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
roleId
Section titled “roleId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
ban(
userId,options?):Promise<void>
Defined in: packages/managers/src/member.ts:105
Bans a user from the guild.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
options?
Section titled “options?”BanOptions = {}
Returns
Section titled “Returns”Promise<void>
clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”edit()
Section titled “edit()”edit(
userId,options):Promise<GuildMember>
Defined in: packages/managers/src/member.ts:122
Edits a guild member (nickname, roles, timeout, mute, deaf). Put the audit-log reason in options.reason.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
options
Section titled “options”Returns
Section titled “Returns”Promise<GuildMember>
editMe()
Section titled “editMe()”editMe(
options):Promise<GuildMember>
Defined in: packages/managers/src/member.ts:78
Changes the bot’s own nickname in this guild (null clears it).
Parameters
Section titled “Parameters”options
Section titled “options”string | null
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<GuildMember>
fetch()
Section titled “fetch()”fetch(
id):Promise<GuildMember>
Defined in: packages/managers/src/base.ts:150
Fetches from Discord; a cached instance is updated in place, so references to it stay current.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<GuildMember>
Inherited from
Section titled “Inherited from”fetchMany()
Section titled “fetchMany()”fetchMany(
ids):Promise<GuildMember[]>
Defined in: packages/managers/src/base.ts:158
Parameters
Section titled “Parameters”Iterable<string>
Returns
Section titled “Returns”Promise<GuildMember[]>
Inherited from
Section titled “Inherited from”find()
Section titled “find()”find(
predicate):GuildMember|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”GuildMember | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
GuildMember|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”GuildMember | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):GuildMember|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”GuildMember | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”kick()
Section titled “kick()”kick(
userId,reason?):Promise<void>
Defined in: packages/managers/src/member.ts:97
Kicks a member from the guild.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
removeRole()
Section titled “removeRole()”removeRole(
userId,roleId,reason?):Promise<void>
Defined in: packages/managers/src/member.ts:154
Removes a role from a member.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
roleId
Section titled “roleId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
resolve()
Section titled “resolve()”resolve(
id):Promise<GuildMember>
Defined in: packages/managers/src/base.ts:145
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<GuildMember>
Inherited from
Section titled “Inherited from”search()
Section titled “search()”search(
query,limit?):Promise<GuildMember[]>
Defined in: packages/managers/src/member.ts:57
Finds members whose username or nickname starts with query (up to limit, 1-1000, default 1).
Parameters
Section titled “Parameters”string
limit?
Section titled “limit?”number = 1
Returns
Section titled “Returns”Promise<GuildMember[]>
set(
id,value):this
Defined in: packages/managers/src/base.ts:88
Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”timeout()
Section titled “timeout()”timeout(
userId,milliseconds,reason?):Promise<GuildMember>
Defined in: packages/managers/src/member.ts:166
Times out a member for a given duration in milliseconds (or clears timeout if null).
Parameters
Section titled “Parameters”userId
Section titled “userId”string
milliseconds
Section titled “milliseconds”number | null
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<GuildMember>
unban()
Section titled “unban()”unban(
userId,reason?):Promise<void>
Defined in: packages/managers/src/member.ts:115
Unbans a user from the guild.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
update()
Section titled “update()”update(
resource):GuildMember
Defined in: packages/managers/src/base.ts:180
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”upsert()
Section titled “upsert()”upsert(
resource):GuildMember
Defined in: packages/managers/src/base.ts:163
Stores a resource, merging into the cached instance when there is one so existing references stay current.
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”The canonical instance.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
GuildMember[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Array of values.