InteractionGuildMember

Represents a guild member

Link

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

Extends

ObjectToLower<Omit<APIInteractionDataResolvedGuildMember, "roles" | "deaf" | "mute" | "permissions">>.Object

Constructors

new InteractionGuildMember(client, data, user, guildId)

1
new InteractionGuildMember(
2
   client: UsingClient,
3
   data: APIInteractionDataResolvedGuildMember,
4
   user: APIUser | User,
5
   guildId: string): InteractionGuildMember

Parameters

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

Returns

InteractionGuildMember

Inherited from

ObjectToLower<Omit<APIInteractionDataResolvedGuildMember, 'roles' | 'deaf' | 'mute' | 'permissions'>>.constructor

Source

seyfert/src/structures/GuildMember.ts:243

Properties

Property	Modifier	Type	Description	Inherited from
`api`	`public`	`APIRoutes`	-	-
`avatar`	`public`	`undefined` \| `null` \| `string`	-	`ObjectToLower.avatar`
`bot`	`public`	`undefined` \| `boolean`	-	-
`cache`	`public`	`Cache`	-	-
`client`	`readonly`	`UsingClient`	-	-
`communicationDisabledUntil`	`public`	`undefined` \| `null` \| `string`	-	`ObjectToLower.communicationDisabledUntil`
`communicationDisabledUntilTimestamp?`	`public`	`null` \| `number`	-	-
`createdAt`	`public`	`Date`	-	-
`createdTimestamp`	`public`	`number`	-	-
`displayName`	`public`	`string`	-	-
`flags`	`public`	`GuildMemberFlags`	-	`ObjectToLower.flags`
`globalName`	`public`	`null` \| `string`	-	-
`guildId`	`readonly`	`string`	the choosen guild id	-
`id`	`public`	`string`	-	-
`joinedAt`	`public`	`string`	-	`ObjectToLower.joinedAt`
`joinedTimestamp?`	`public`	`number`	-	-
`name`	`public`	`string`	-	-
`nick`	`public`	`undefined` \| `null` \| `string`	-	`ObjectToLower.nick`
`pending`	`public`	`undefined` \| `boolean`	-	`ObjectToLower.pending`
`permissions`	`public`	`PermissionsBitField`	-	-
`premiumSince`	`public`	`undefined` \| `null` \| `string`	-	`ObjectToLower.premiumSince`
`rest`	`public`	`ApiHandler`	-	-
`roles`	`public`	`Object`	-	-
`roles.add`	`public`	(`id`: `string`) => `void`	-	-
`roles.highest`	`public`	(`force`: `boolean`) => `Promise`<`GuildRole`>	-	-
`roles.keys`	`public`	`string`[]	-	-
`roles.list`	`public`	(`force`: `boolean`) => `Promise`<`GuildRole`[]>	-	-
`roles.permissions`	`public`	(`force`: `boolean`) => `Promise`<`PermissionsBitField`>	-	-
`roles.remove`	`public`	(`id`: `string`) => `Promise`<`never`>	-	-
`roles.sorted`	`public`	(`force`: `boolean`) => `Promise`<`GuildRole`[]>	-	-
`tag`	`public`	`string`	-	-
`user`	`public`	`User`	-	-
`username`	`public`	`string`	-	-

Methods

avatarURL()

1
avatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

string

Source

seyfert/src/structures/GuildMember.ts:179

ban()

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

Parameters

Parameter	Type
`body`?	`RESTPutAPIGuildBanJSONBody`
`reason`?	`string`

Returns

Promise<void>

Source

seyfert/src/structures/GuildMember.ts:58

bannable()

1
bannable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:209

bannerURL()

1
bannerURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

undefined | string

Source

seyfert/src/structures/GuildMember.ts:191

dm()

1
dm(force: boolean): Promise<DMChannel>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<DMChannel>

Source

seyfert/src/structures/GuildMember.ts:171

dynamicAvatarURL()

1
dynamicAvatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

string

Source

seyfert/src/structures/GuildMember.ts:183

edit()

1
edit(...args: [RESTPatchAPIGuildMemberJSONBody, string]): Promise<InteractionGuildMember>

Parameters

Parameter	Type
…`args`	[`RESTPatchAPIGuildMemberJSONBody`, `string`]

Returns

Promise<InteractionGuildMember>

Source

seyfert/src/structures/GuildMember.ts:66

fetch()

1
fetch(...args: [boolean]): Promise<InteractionGuildMember>

Parameters

Parameter	Type
…`args`	[`boolean`]

Returns

Promise<InteractionGuildMember>

Source

seyfert/src/structures/GuildMember.ts:54

fetchPermissions()

1
fetchPermissions(force: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<PermissionsBitField>

Source

seyfert/src/structures/GuildMember.ts:195

guild()

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

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

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

Source

seyfert/src/structures/GuildMember.ts:50

kick()

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

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<void>

Source

seyfert/src/structures/GuildMember.ts:62

kickable()

1
kickable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:213

manageable()

1
manageable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:200

moderatable()

1
moderatable(force: boolean): Promise<boolean>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<boolean>

Source

seyfert/src/structures/GuildMember.ts:217

presence()

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

Returns

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

Source

seyfert/src/structures/GuildMember.ts:70

toString()

1
toString(): string

Returns

string

Source

seyfert/src/structures/GuildMember.ts:78

voice()

1
voice(): ReturnCache<undefined | VoiceState>

Returns

ReturnCache<undefined | VoiceState>

Source

seyfert/src/structures/GuildMember.ts:74

write()

1
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