Class GuildMember

Hierarchy

BaseStructure<APIGuildMember>
- GuildMember

Constructors

constructor

new GuildMember(client: Client, guildId: string): GuildMember

Overrides BaseStructure.constructor
- Defined in src/structures/GuildMember.ts:60
Parameters
- client: Client
- guildId: string
Returns GuildMember

Properties

avatar

avatar: null | string = null

client

client: Client

communicationDisabledUntil

communicationDisabledUntil: null | Date = null

deaf

deaf: boolean = false

flags

flags: GuildMemberFlags = ...

guildId

guildId: string

id

id: string

joinedAt

joinedAt: Date

mute

mute: boolean = false

nickname

nickname: null | string = null

pending

pending: boolean = false

premiumSince

premiumSince: null | Date = null

userId

userId: null | string = null

Accessors

communicationDisabledUntilTimestamp

get communicationDisabledUntilTimestamp(): null | number

- Defined in src/structures/GuildMember.ts:37
Returns null | number

createdAt

get createdAt(): Date

Overrides BaseStructure.createdAt
- Defined in src/structures/GuildMember.ts:14
deprecated
use GuildMember.joinedAt instead

Returns Date

createdTimestamp

get createdTimestamp(): number

Overrides BaseStructure.createdTimestamp
- Defined in src/structures/GuildMember.ts:20
deprecated
use GuildMember.joinedTimestamp instead

Returns number

guild

get guild(): Guild

- Defined in src/structures/GuildMember.ts:24
Returns Guild

joinedTimestamp

get joinedTimestamp(): number

- Defined in src/structures/GuildMember.ts:45
Returns number

premiumSinceTimestamp

get premiumSinceTimestamp(): null | number

- Defined in src/structures/GuildMember.ts:50
Returns null | number

user

get user(): null | User

- Defined in src/structures/GuildMember.ts:28
Returns null | User

Methods

_deserialise

_deserialise(data: APIGuildMember & { joined_at: null | string }): GuildMember

Overrides BaseStructure._deserialise
- Defined in src/structures/GuildMember.ts:64
Parameters
- data: APIGuildMember & { joined_at: null | string }
Returns GuildMember

_patch

_patch(data: APIGuildMember, guild?: Guild, user?: User): GuildMember

- Defined in src/structures/GuildMember.ts:92
Parameters
- data: APIGuildMember
- Optional guild: Guild
- Optional user: User
Returns GuildMember

ban

ban(options?: BanGuildMemberOptions): Promise<void>

- Defined in src/structures/GuildMember.ts:149
Parameters
- options: BanGuildMemberOptions = {}
Returns Promise<void>

disableCommunication

disableCommunication(until: number | Date, reason?: string): Promise<GuildMember>

- Defined in src/structures/GuildMember.ts:134
Parameters
- until: number | Date
- Optional reason: string
Returns Promise<GuildMember>

edit

edit(data: Partial<APIGuildMember | GuildMember>, reason?: string): Promise<GuildMember>

- Defined in src/structures/GuildMember.ts:116
Parameters
- data: Partial<APIGuildMember | GuildMember>
- Optional reason: string
Returns Promise<GuildMember>

fetch

fetch(): Promise<GuildMember>

- Defined in src/structures/GuildMember.ts:103
Returns Promise<GuildMember>

isCommunicationDisabled

isCommunicationDisabled(): boolean

- Defined in src/structures/GuildMember.ts:40
Returns boolean

isPremiumSupporter

isPremiumSupporter(): boolean

- Defined in src/structures/GuildMember.ts:53
Returns boolean

kick

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

- Defined in src/structures/GuildMember.ts:157
Parameters
- Optional reason: string
Returns Promise<void>

setDeaf

setDeaf(deaf: boolean, reason?: string): Promise<void>

- Defined in src/structures/GuildMember.ts:169
Parameters
- deaf: boolean
- Optional reason: string
Returns Promise<void>

setMute

setMute(mute: boolean, reason?: string): Promise<void>

- Defined in src/structures/GuildMember.ts:173
Parameters
- mute: boolean
- Optional reason: string
Returns Promise<void>

setNickname

setNickname(nickname: string, reason?: string): Promise<void>

- Defined in src/structures/GuildMember.ts:165
Parameters
- nickname: string
- Optional reason: string
Returns Promise<void>

toJSON

toJSON(): APIGuildMember

Overrides BaseStructure.toJSON
- Defined in src/structures/GuildMember.ts:177
Returns APIGuildMember

unban

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

- Defined in src/structures/GuildMember.ts:153
Parameters
- Optional reason: string
Returns Promise<void>

Static toJSON

toJSON(data: any): any

Inherited from BaseStructure.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc