MemberHandle
Defined in: packages/core/src/handles.ts:192
A guild member, by guild id and user id. Made by bot.member(guildId, userId).
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MemberHandle(
bot,guildId,userId):MemberHandle
Defined in: packages/core/src/handles.ts:193
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
userId
Section titled “userId”string
Returns
Section titled “Returns”MemberHandle
Properties
Section titled “Properties”guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/core/src/handles.ts:195
userId
Section titled “userId”
readonlyuserId:string
Defined in: packages/core/src/handles.ts:196
Methods
Section titled “Methods”addRole()
Section titled “addRole()”addRole(
roleId,reason?):Promise<void>
Defined in: packages/core/src/handles.ts:233
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
ban(
options?):Promise<void>
Defined in: packages/core/src/handles.ts:223
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
edit()
Section titled “edit()”edit(
options):Promise<GuildMember>
Defined in: packages/core/src/handles.ts:230
Changes nickname, roles, mute or deafen; put the audit-log reason in options.reason.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<GuildMember>
fetch()
Section titled “fetch()”fetch():
Promise<GuildMember>
Defined in: packages/core/src/handles.ts:209
Returns
Section titled “Returns”Promise<GuildMember>
Implementation of
Section titled “Implementation of”get():
Promise<GuildMember>
Defined in: packages/core/src/handles.ts:206
Returns
Section titled “Returns”Promise<GuildMember>
Implementation of
Section titled “Implementation of”guild()
Section titled “guild()”guild():
GuildHandle
Defined in: packages/core/src/handles.ts:213
Returns
Section titled “Returns”kick()
Section titled “kick()”kick(
reason?):Promise<void>
Defined in: packages/core/src/handles.ts:220
Parameters
Section titled “Parameters”reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
peek()
Section titled “peek()”peek():
GuildMember|undefined
Defined in: packages/core/src/handles.ts:203
Returns
Section titled “Returns”GuildMember | undefined
Implementation of
Section titled “Implementation of”removeRole()
Section titled “removeRole()”removeRole(
roleId,reason?):Promise<void>
Defined in: packages/core/src/handles.ts:236
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
timeout()
Section titled “timeout()”timeout(
duration,reason?):Promise<GuildMember>
Defined in: packages/core/src/handles.ts:243
Times the member out for duration ("10m", "2h", 90_000), or lifts
the timeout with null.
Parameters
Section titled “Parameters”duration
Section titled “duration”Duration | null
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<GuildMember>
unban()
Section titled “unban()”unban(
reason?):Promise<void>
Defined in: packages/core/src/handles.ts:226
Parameters
Section titled “Parameters”reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
user()
Section titled “user()”user():
UserHandle
Defined in: packages/core/src/handles.ts:216