BaseGuildMember

Extends

DiscordBase.ObjectToLower<Omit<APIGuildMember, "user" | "roles">>

Constructors

new BaseGuildMember(client, data, id, guildId)

1
new BaseGuildMember(
2
   client: UsingClient,
3
   data: GuildMemberData,
4
   id: string,
5
   guildId: string): BaseGuildMember

Parameters

Parameter	Type	Description
`client`	`UsingClient`	-
`data`	`GuildMemberData`	-
`id`	`string`	-
`guildId`	`string`	the choosen guild id

Returns

BaseGuildMember

Inherited from

DiscordBase.constructor

Source

seyfert/src/structures/GuildMember.ts:37

Properties

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

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

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

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

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

roles

1
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

Methods

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

edit()

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

Parameters

Parameter	Type
`body`	`RESTPatchAPIGuildMemberJSONBody`
`reason`?	`string`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/GuildMember.ts:66

fetch()

1
fetch(force: boolean): Promise<GuildMember>

Parameters

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

Returns

Promise<GuildMember>

Source

seyfert/src/structures/GuildMember.ts:54

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

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

methods()

1
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`>	-

Source

seyfert/src/structures/GuildMember.ts:109