Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Member

Guild Member Structure

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysMember

_keysMerge

_keysMerge: BaseSet<string> = keysMergeMember

Optional _roles

_roles: Array<string>

client

client: ShardClient

deaf

deaf: boolean = false

guildId

guildId: string = ""

hoistedRoleId

hoistedRoleId: null | string = null

joinedAtUnix

joinedAtUnix: number = 0

left

left: boolean = false

mute

mute: boolean = false

nick

nick: null | string = null

premiumSinceUnix

premiumSinceUnix: number = 0

user

user: User

Accessors

avatar

  • get avatar(): null | string
  • Returns null | string

avatarUrl

  • get avatarUrl(): string

bot

  • get bot(): boolean
  • Returns boolean

canAdministrator

  • get canAdministrator(): boolean
  • Returns boolean

canBanMembers

  • get canBanMembers(): boolean
  • Returns boolean

canChangeNickname

  • get canChangeNickname(): boolean
  • Returns boolean

canChangeNicknames

  • get canChangeNicknames(): boolean
  • Returns boolean

canCreateInstantInvite

  • get canCreateInstantInvite(): boolean
  • Returns boolean

canKickMembers

  • get canKickMembers(): boolean
  • Returns boolean

canManageChannels

  • get canManageChannels(): boolean
  • Returns boolean

canManageEmojis

  • get canManageEmojis(): boolean
  • Returns boolean

canManageGuild

  • get canManageGuild(): boolean
  • Returns boolean

canManageMessages

  • get canManageMessages(): boolean
  • Returns boolean

canManageRoles

  • get canManageRoles(): boolean
  • Returns boolean

canManageWebhooks

  • get canManageWebhooks(): boolean
  • Returns boolean

canViewAuditLogs

  • get canViewAuditLogs(): boolean
  • Returns boolean

color

  • get color(): number
  • Returns number

colorRole

  • get colorRole(): null | Role
  • Returns null | Role

createdAt

  • get createdAt(): Date

createdAtUnix

  • get createdAtUnix(): number

defaultAvatarUrl

  • get defaultAvatarUrl(): string

discriminator

  • get discriminator(): string

dm

  • Returns Channel | null

guild

  • get guild(): Guild | null
  • Returns Guild | null

guilds

  • get guilds(): BaseCollection<string, Guild>
  • Returns BaseCollection<string, Guild>

hasBugHunterLevel1

  • get hasBugHunterLevel1(): boolean

hasBugHunterLevel2

  • get hasBugHunterLevel2(): boolean

hasEarlySupporter

  • get hasEarlySupporter(): boolean

hasHypesquad

  • get hasHypesquad(): boolean

hasHypesquadHouseBalance

  • get hasHypesquadHouseBalance(): boolean

hasHypesquadHouseBravery

  • get hasHypesquadHouseBravery(): boolean

hasHypesquadHouseBrilliance

  • get hasHypesquadHouseBrilliance(): boolean

hasMfaSms

  • get hasMfaSms(): boolean
  • Returns boolean

hasPartner

  • get hasPartner(): boolean

hasPremiumPromoDismissed

  • get hasPremiumPromoDismissed(): boolean

hasStaff

  • get hasStaff(): boolean
  • Returns boolean

hasTeamUser

  • get hasTeamUser(): boolean

hasVerifiedBot

  • get hasVerifiedBot(): boolean

hasVerifiedDeveloper

  • get hasVerifiedDeveloper(): boolean

highestRole

  • get highestRole(): null | Role
  • Returns null | Role

hoistedRole

  • get hoistedRole(): null | Role
  • Returns null | Role

id

  • get id(): string
  • Returns string

isBoosting

  • get isBoosting(): boolean
  • Returns boolean

isClientOwner

  • get isClientOwner(): boolean

isMe

  • get isMe(): boolean
  • Returns boolean

isOffline

  • get isOffline(): boolean
  • Returns boolean

isOwner

  • get isOwner(): boolean
  • Returns boolean

isPartial

  • get isPartial(): boolean
  • Returns boolean

isSystem

  • get isSystem(): boolean
  • Returns boolean

isWebhook

  • get isWebhook(): boolean
  • Returns boolean

joinedAt

  • get joinedAt(): Date | null
  • Returns Date | null

jumpLink

  • get jumpLink(): string
  • Returns string

mention

  • get mention(): string
  • Returns string

messages

  • get messages(): BaseCollection<string, Message>

name

  • get name(): string
  • Returns string

names

  • get names(): Array<string>
  • Returns Array<string>

note

  • get note(): string
  • Returns string

permissions

  • get permissions(): number
  • Returns number

premiumSince

  • get premiumSince(): Date | null
  • Returns Date | null

presence

publicFlags

  • get publicFlags(): number

roles

  • get roles(): BaseCollection<string, null | Role>
  • Returns BaseCollection<string, null | Role>

shardId

  • get shardId(): number
  • Returns number

system

  • get system(): boolean | undefined
  • Returns boolean | undefined

username

  • get username(): string
  • Returns string

voiceChannel

voiceState

  • Returns null | VoiceState

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

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

    • key: string
    • value: any

    Returns any

add

  • add(): Promise<any>
  • Returns Promise<any>

addRole

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

    • roleId: string
    • Default value options: AddGuildMemberRole = {}

    Returns Promise<any>

avatarUrlFormat

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

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns string

ban

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

    • Default value options: CreateGuildBan = {}

    Returns Promise<any>

block

  • block(): Promise<any>
  • Returns Promise<any>

can

  • can(permissions: PermissionTools.PermissionChecks, options?: object): boolean
  • Parameters

    • permissions: PermissionTools.PermissionChecks
    • Default value options: object = {}
      • Optional ignoreAdministrator?: undefined | false | true
      • Optional ignoreOwner?: undefined | false | true

    Returns boolean

canEdit

  • canEdit(member: Member): boolean
  • Parameters

    Returns boolean

createDm

createMessage

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

    • Default value options: CreateMessage | string = {}

    Returns Promise<any>

createOrGetDm

deleteRelationship

  • deleteRelationship(): Promise<any>

difference

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

    • key: string
    • value: any

    Returns [boolean, any]

differences

edit

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

    • Default value options: EditGuildMember = {}

    Returns Promise<any>

editNick

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

    • nick: string
    • Default value options: EditGuildNick = {}

    Returns Promise<any>

editNote

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

    • note: string

    Returns Promise<any>

editRelationship

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

    • type: number

    Returns Promise<any>

fetchProfile

hasFlag

  • hasFlag(flag: number): boolean
  • Parameters

    • flag: number

    Returns boolean

hasPublicFlag

  • hasPublicFlag(flag: number): boolean
  • Parameters

    • flag: number

    Returns boolean

merge

mergeValue

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

    • key: string
    • value: any

    Returns void

move

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

    • channelId: null | string
    • Default value options: EditGuildMember = {}

    Returns Promise<any>

permissionsIn

  • Parameters

    Returns number

remove

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

    • Default value options: RemoveGuildMember = {}

    Returns Promise<any>

removeBan

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

    • Default value options: RemoveGuildBan = {}

    Returns Promise<any>

removeRole

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

    • roleId: string
    • Default value options: RemoveGuildMemberRole = {}

    Returns Promise<any>

setDeaf

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

    • deaf: boolean
    • Default value options: EditGuildMember = {}

    Returns Promise<any>

setMute

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

    • mute: boolean
    • Default value options: EditGuildMember = {}

    Returns Promise<any>

toJSON

  • toJSON(withRoles?: undefined | false | true): any
  • Parameters

    • Optional withRoles: undefined | false | true

    Returns any

toString

  • toString(): string
  • Returns string

unadd

  • unadd(): Promise<any>
  • Returns Promise<any>

unblock

  • unblock(): Promise<any>
  • Returns Promise<any>

Generated using TypeDoc