Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Member

Guild Member Structure

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_avatar

_avatar: null | string = null

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

Readonly _keysSkipDifference

_keysSkipDifference: BaseSet<string> = ...

Optional _permissions

_permissions: bigint = ...

Optional _roles

_roles: string[]

Readonly client

client: ShardClient

deaf

deaf: boolean = false

guildId

guildId: string = ''

hoistedRoleId

hoistedRoleId: null | string = null

isPending

isPending: boolean = false

joinedAtUnix

joinedAtUnix: number = 0

left

left: boolean = false

mute

mute: boolean = false

nick

nick: null | string = null

pending

pending: boolean = false

premiumSinceUnix

premiumSinceUnix: number = 0

user

user: User

Accessors

avatar

  • get avatar(): null | string

avatarUrl

  • get avatarUrl(): string

bot

  • get bot(): boolean

canAdministrator

  • get canAdministrator(): boolean

canBanMembers

  • get canBanMembers(): boolean

canChangeNickname

  • get canChangeNickname(): boolean

canChangeNicknames

  • get canChangeNicknames(): boolean

canCreateInstantInvite

  • get canCreateInstantInvite(): boolean

canKickMembers

  • get canKickMembers(): boolean

canManageChannels

  • get canManageChannels(): boolean

canManageEmojis

  • get canManageEmojis(): boolean

canManageGuild

  • get canManageGuild(): boolean

canManageMessages

  • get canManageMessages(): boolean

canManageRoles

  • get canManageRoles(): boolean

canManageThreads

  • get canManageThreads(): boolean

canManageWebhooks

  • get canManageWebhooks(): boolean

canRequestToSpeak

  • get canRequestToSpeak(): boolean

canUseApplicationCommands

  • get canUseApplicationCommands(): boolean

canUsePrivateThreads

  • get canUsePrivateThreads(): boolean

canUsePublicThreads

  • get canUsePublicThreads(): boolean

canViewAuditLogs

  • get canViewAuditLogs(): boolean

color

  • get color(): number

colorRole

  • get colorRole(): null | Role

createdAt

  • get createdAt(): Date

createdAtUnix

  • get createdAtUnix(): number

defaultAvatarUrl

  • get defaultAvatarUrl(): string

discriminator

  • get discriminator(): string

dm

guild

  • get guild(): null | Guild

guilds

hasBugHunterLevel1

  • get hasBugHunterLevel1(): boolean

hasBugHunterLevel2

  • get hasBugHunterLevel2(): boolean

hasDiscordCertifiedModerator

  • get hasDiscordCertifiedModerator(): boolean

hasEarlySupporter

  • get hasEarlySupporter(): boolean

hasFreePremium

  • get hasFreePremium(): boolean

hasGuildAvatar

  • get hasGuildAvatar(): boolean

hasHypesquad

  • get hasHypesquad(): boolean

hasHypesquadHouseBalance

  • get hasHypesquadHouseBalance(): boolean

hasHypesquadHouseBravery

  • get hasHypesquadHouseBravery(): boolean

hasHypesquadHouseBrilliance

  • get hasHypesquadHouseBrilliance(): boolean

hasMfaSms

  • get hasMfaSms(): boolean

hasPartner

  • get hasPartner(): boolean

hasPremiumPromoDismissed

  • get hasPremiumPromoDismissed(): boolean

hasStaff

  • get hasStaff(): boolean

hasTeamUser

  • get hasTeamUser(): boolean

hasVerifiedBot

  • get hasVerifiedBot(): boolean

hasVerifiedDeveloper

  • get hasVerifiedDeveloper(): boolean

highestRole

  • get highestRole(): null | Role

hoistedRole

  • get hoistedRole(): null | Role

id

  • get id(): string

isBoosting

  • get isBoosting(): boolean

isClientOwner

  • get isClientOwner(): boolean

isClone

  • get isClone(): boolean

isMe

  • get isMe(): boolean

isOffline

  • get isOffline(): boolean

isOwner

  • get isOwner(): boolean

isPartial

  • get isPartial(): boolean

isSystem

  • get isSystem(): boolean

isWebhook

  • get isWebhook(): boolean

joinedAt

  • get joinedAt(): null | Date

jumpLink

  • get jumpLink(): string

mention

  • get mention(): string

messages

name

  • get name(): string

names

  • get names(): string[]

note

  • get note(): string

permissions

  • get permissions(): bigint

premiumSince

  • get premiumSince(): null | Date

presence

publicFlags

  • get publicFlags(): number

roles

shardId

  • get shardId(): number

system

  • get system(): undefined | boolean

tag

  • get tag(): string

username

  • get username(): string

voiceChannel

voiceState

Methods

[custom]

  • [custom](): object

_getFromSnake

  • _getFromSnake(key: string): any

_setFromSnake

  • _setFromSnake(key: string, value: any): any

add

  • add(): Promise<any>

addRole

  • addRole(roleId: string, options?: AddGuildMemberRole): Promise<any>

avatarUrlFormat

  • avatarUrlFormat(format?: null | string, query?: UrlQuery): string

ban

  • ban(options?: CreateGuildBan): Promise<any>

block

  • block(): Promise<any>

can

  • can(permissions: PermissionChecks, options?: { ignoreAdministrator?: boolean; ignoreOwner?: boolean }): boolean

  • Parameters

    • permissions: PermissionChecks
    • options: { ignoreAdministrator?: boolean; ignoreOwner?: boolean } = {}
      • Optional ignoreAdministrator?: boolean
      • Optional ignoreOwner?: boolean

    Returns boolean

canEdit

  • canEdit(member: Member): boolean

canEditRole

  • canEditRole(roleId: string | Role): boolean

clone

createDm

createMessage

  • createMessage(options?: string | CreateMessage): Promise<Message>

createOrGetDm

  • createOrGetDm(): Promise<Channel>

deleteRelationship

  • deleteRelationship(): Promise<any>

difference

  • difference(key: string, value: any): [boolean, any]

differences

differencesBetween

  • differencesBetween(structure: Structure): null | object

edit

  • edit(options?: EditGuildMember): Promise<any>

editNick

  • editNick(nick: string, options?: EditGuildNick): Promise<any>

editNote

  • editNote(note: string): Promise<any>

editRelationship

  • editRelationship(type: number): Promise<any>

editVoiceState

  • editVoiceState(options: EditGuildVoiceState): Promise<any>

fetchProfile

hasDifference

  • hasDifference(key: string, value: any): boolean

hasDifferences

hasDifferencesBetween

  • hasDifferencesBetween(structure: Structure): boolean

hasFlag

  • hasFlag(flag: number): boolean

hasPublicFlag

  • hasPublicFlag(flag: number): boolean

merge

mergeValue

  • mergeValue(key: string, value: any): void

move

  • move(channelId: null | string, options?: EditGuildMember): Promise<any>

permissionsIn

  • permissionsIn(channelId: string | Channel): bigint

remove

  • remove(options?: RemoveGuildMember): Promise<any>

removeBan

  • removeBan(options?: RemoveGuildBan): Promise<any>

removeRole

  • removeRole(roleId: string, options?: RemoveGuildMemberRole): Promise<any>

setDeaf

  • setDeaf(deaf: boolean, options?: EditGuildMember): Promise<any>

setMute

  • setMute(mute: boolean, options?: EditGuildMember): Promise<any>

toJSON

  • toJSON(withRoles?: boolean): any

toString

  • toString(): string

unadd

  • unadd(): Promise<any>

unblock

  • unblock(): Promise<any>

Generated using TypeDoc