GuildMember

Represents a guild member

Link

https://discord.com/developers/docs/resources/guild#guild-member-object

Extends

• ObjectToLower<Omit<APIGuildMember, "user" | "roles">>.BaseGuildMember

Constructors

new GuildMember(client, data, user, guildId)

new GuildMember(
   client: UsingClient,
   data: GuildMemberData,
   user: APIUser | User,
   guildId: string): GuildMember

Parameters

Parameter	Type	Description
client	UsingClient	-
data	GuildMemberData	-
user	APIUser | User	-
guildId	string	the choosen guild id

Returns

GuildMember

Inherited from

BaseGuildMember.constructor

Source

seyfert/src/structures/GuildMember.ts:135

Properties

Property	Modifier	Type	Description	Inherited from
avatar	public	undefined | null | string	-	BaseGuildMember.avatar
client	readonly	UsingClient	-	BaseGuildMember.client
communicationDisabledUntil	public	undefined | null | string	-	BaseGuildMember.communicationDisabledUntil
communicationDisabledUntilTimestamp?	public	null | number	-	BaseGuildMember.communicationDisabledUntilTimestamp
deaf	public	boolean	-	BaseGuildMember.deaf
flags	public	GuildMemberFlags	-	BaseGuildMember.flags
guildId	readonly	string	the choosen guild id	BaseGuildMember.guildId
id	public	string	-	BaseGuildMember.id
joinedAt	public	string	-	BaseGuildMember.joinedAt
joinedTimestamp?	public	number	-	BaseGuildMember.joinedTimestamp
mute	public	boolean	-	BaseGuildMember.mute
nick	public	undefined | null | string	-	BaseGuildMember.nick
pending	public	undefined | boolean	-	BaseGuildMember.pending
premiumSince	public	undefined | null | string	-	BaseGuildMember.premiumSince
user	public	User	-	-

Accessors

bot

get bot(): undefined | boolean

Returns

undefined | boolean

Source

seyfert/src/structures/GuildMember.ts:150

---

createdAt

get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

---

createdTimestamp

get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

---

displayName

get displayName(): string

gets the nickname or the username

Returns

string

Source

seyfert/src/structures/GuildMember.ts:167

---

globalName

get globalName(): null | string

Returns

null | string

Source

seyfert/src/structures/GuildMember.ts:162

---

name

get name(): string

Returns

string

Source

seyfert/src/structures/GuildMember.ts:154

---

roles

get roles(): Object

Returns

Object

Member	Type	Value
add	(id: string) => void	-
highest	(force: boolean) => Promise<GuildRole>	-
keys	string[]	-
list	(force: boolean) => Promise<GuildRole[]>	-
permissions	(force: boolean) => Promise<PermissionsBitField>	-
remove	(id: string) => Promise<never>	-
sorted	(force: boolean) => Promise<GuildRole[]>	-

Source

seyfert/src/structures/GuildMember.ts:93

---

tag

get tag(): string

Returns

string

Source

seyfert/src/structures/GuildMember.ts:146

---

username

get username(): string

Returns

string

Source

seyfert/src/structures/GuildMember.ts:158

Methods

avatarURL()

avatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

string

Source

seyfert/src/structures/GuildMember.ts:179

---

ban()

ban(body?: RESTPutAPIGuildBanJSONBody, reason?: string): Promise<void>

Parameters

Parameter	Type
body?	RESTPutAPIGuildBanJSONBody
reason?	string

Returns

Promise<void>

Inherited from

BaseGuildMember.ban

Source

seyfert/src/structures/GuildMember.ts:58

---

bannable()

bannable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:209

---

bannerURL()

bannerURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

undefined | string

Source

seyfert/src/structures/GuildMember.ts:191

---

dm()

dm(force: boolean): Promise<DMChannel>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<DMChannel>

Source

seyfert/src/structures/GuildMember.ts:171

---

dynamicAvatarURL()

dynamicAvatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

string

Source

seyfert/src/structures/GuildMember.ts:183

---

edit()

edit(body: RESTPatchAPIGuildMemberJSONBody, reason?: string): Promise<GuildMember>

Parameters

Parameter	Type
body	RESTPatchAPIGuildMemberJSONBody
reason?	string

Returns

Promise<GuildMember>

Inherited from

BaseGuildMember.edit

Source

seyfert/src/structures/GuildMember.ts:66

---

fetch()

fetch(force: boolean): Promise<GuildMember>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<GuildMember>

Inherited from

BaseGuildMember.fetch

Source

seyfert/src/structures/GuildMember.ts:54

---

fetchPermissions()

fetchPermissions(force: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<PermissionsBitField>

Source

seyfert/src/structures/GuildMember.ts:195

---

guild()

guild(force: boolean): Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<Guild<"cached"> | Guild<"api">>

Inherited from

BaseGuildMember.guild

Source

seyfert/src/structures/GuildMember.ts:50

---

kick()

kick(reason?: string): Promise<void>

Parameters

Parameter	Type
reason?	string

Returns

Promise<void>

Inherited from

BaseGuildMember.kick

Source

seyfert/src/structures/GuildMember.ts:62

---

kickable()

kickable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:213

---

manageable()

manageable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:200

---

moderatable()

moderatable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:217

---

presence()

presence(): ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Returns

ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Inherited from

BaseGuildMember.presence

Source

seyfert/src/structures/GuildMember.ts:70

---

toString()

toString(): string

Returns

string

Inherited from

BaseGuildMember.toString

Source

seyfert/src/structures/GuildMember.ts:78

---

voice()

voice(): ReturnCache<undefined | VoiceState>

Returns

ReturnCache<undefined | VoiceState>

Inherited from

BaseGuildMember.voice

Source

seyfert/src/structures/GuildMember.ts:74

---

write()

write(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps): Promise<Message>

Parameters

Parameter	Type
body	Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps

Returns

Promise<Message>

Source

seyfert/src/structures/GuildMember.ts:175

---

methods()

static methods(__namedParameters:     Object): Object

Parameters

Parameter	Type
__namedParameters	Object
__namedParameters.client	UsingClient
__namedParameters.guildId	string

Returns

Object

Member	Type	Value
add	(id: string, body: RESTPutAPIGuildMemberJSONBody) => Promise<undefined | GuildMember>	-
ban	(id: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string) => Promise<void>	-
edit	(id: string, body: RESTPatchAPIGuildMemberJSONBody, reason?: string) => Promise<GuildMember>	-
fetch	(memberId: string, force: boolean) => Promise<GuildMember>	-
kick	(id: string, reason?: string) => Promise<void>	-
list	(query?: RESTGetAPIGuildMembersQuery, force: boolean) => Promise<GuildMember[]>	-
resolve	(resolve: GuildMemberResolvable) => Promise<undefined | GuildMember>	-
search	(query?: RESTGetAPIGuildMembersSearchQuery) => Promise<GuildMember[]>	-
unban	(id: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string) => Promise<void>	-

Inherited from

BaseGuildMember.methods

Source

seyfert/src/structures/GuildMember.ts:109