Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserExtended

User Extended Structure received from /users/@me calls with an oauth2 token with correct permissions

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysUserExtended

avatar

avatar: string | null = null

bot

bot: boolean = false

client

client: ShardClient

discriminator

discriminator: string = "0000"

Optional email

email: string | null

flags

flags: number = 0

id

id: string = ""

Optional locale

locale: string | null

mfaEnabled

mfaEnabled: boolean = false

premiumType

premiumType: number = 0

publicFlags

publicFlags: number = 0

Optional system

system: undefined | false | true

username

username: string = ""

verified

verified: boolean = false

Accessors

avatarUrl

  • get avatarUrl(): string
  • Returns string

createdAt

  • get createdAt(): Date
  • Returns Date

createdAtUnix

  • get createdAtUnix(): number
  • Returns number

defaultAvatarUrl

  • get defaultAvatarUrl(): string

dm

  • Returns Channel | 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
  • Returns boolean

hasHypesquadHouseBalance

  • get hasHypesquadHouseBalance(): boolean

hasHypesquadHouseBravery

  • get hasHypesquadHouseBravery(): boolean

hasHypesquadHouseBrilliance

  • get hasHypesquadHouseBrilliance(): boolean

hasMfaSms

  • get hasMfaSms(): boolean
  • Returns boolean

hasNitro

  • get hasNitro(): boolean
  • Returns boolean

hasNitroClassic

  • get hasNitroClassic(): boolean
  • Returns boolean

hasPartner

  • get hasPartner(): boolean
  • Returns boolean

hasPremiumPromoDismissed

  • get hasPremiumPromoDismissed(): boolean

hasStaff

  • get hasStaff(): boolean
  • Returns boolean

hasTeamUser

  • get hasTeamUser(): boolean
  • Returns boolean

hasVerifiedBot

  • get hasVerifiedBot(): boolean
  • Returns boolean

hasVerifiedDeveloper

  • get hasVerifiedDeveloper(): boolean

isClaimed

  • get isClaimed(): boolean
  • Returns boolean

isClientOwner

  • get isClientOwner(): boolean
  • Returns boolean

isMe

  • get isMe(): boolean
  • Returns boolean

isSystem

  • get isSystem(): boolean
  • Returns boolean

isWebhook

  • get isWebhook(): boolean
  • Returns boolean

jumpLink

  • get jumpLink(): string
  • Returns string

mention

  • get mention(): string
  • Returns string

messages

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

name

  • get name(): string
  • Returns string

names

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

note

  • get note(): string
  • Returns string

presence

shardId

  • get shardId(): number
  • Returns number

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>

avatarUrlFormat

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

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

    Returns string

block

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

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

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

hasPremiumType

  • hasPremiumType(type: number): boolean
  • Parameters

    • type: 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

toJSON

  • toJSON(): object
  • Returns object

toString

  • toString(): string
  • Returns string

unadd

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

unblock

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

Generated using TypeDoc