Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientUser

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: Client

The client that instantiated this structure

data

data: APIUser

Raw User data

Accessors

accentColor

  • get accentColor(): undefined | null | number

  • The base 10 accent color of the user's banner

    Returns undefined | null | number

avatar

  • get avatar(): null | string

  • The user avatar's hash

    Returns null | string

banner

  • get banner(): undefined | null | string

  • The user banner's hash

    Returns undefined | null | string

bot

  • get bot(): boolean

  • Whether or not the user is a bot

    Returns boolean

createdAt

  • get createdAt(): Date

  • The time the user was created at

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the user was created at

    Returns number

discriminator

  • get discriminator(): string

  • The discriminator of the user

    Returns string

dmChannel

  • get dmChannel(): undefined | Channel

  • The DMChannel between the client's user and this user

    Returns undefined | Channel

flags

  • Returns UserFlagsBitField

id

  • get id(): string

  • The user's Id

    Returns string

system

  • get system(): undefined | boolean

  • Whether the user is an Official Discord System user (part of the urgent message system)

    Returns undefined | boolean

tag

  • get tag(): null | string

  • The Discord "tag" (e.g. Veric#2755) for this user

    Returns null | string

username

  • get username(): string

  • The username of the user

    Returns string

verified

  • get verified(): undefined | boolean

  • Whether or not the user is verified

    Returns undefined | boolean

Methods

avatarURL

  • A link to the user's avatar

    Parameters

    Returns null | string

bannerURL

  • A link to the user's banner

    Parameters

    Returns null | string

clone

  • clone(): any

  • Returns any

createDM

displayAvatarURL

  • A link to the user's avatar if they have one. Otherwise a link to their default avatar will be returned

    Parameters

    Returns null | string

fetch

  • fetch(): Promise<User>

  • Fetches this user

    Returns Promise<User>

Private parseData

send

  • Sends a message to this user

    example
    const { Embed } = require('helly');
    const embed = new Embed().setTitle('Pong!')
    user.send({ embeds: [embed] })
    example
    const { Embed } = require('helly');
    const embed = new Embed().setTitle('Pong!')
    user.send({ content: 'Ping?', embeds: [embed] })
    example
    user.send('Hello world!')

    Parameters

    Returns Promise<Message>

setAFK

  • setAFK(afk?: boolean): void

  • Sets/removes the AFK flag for the client user This will clear your activity and status!

    example
    client.user.setAFK(true);
    example
    client.user.setAFK(false);

    Parameters

    • afk: boolean = true

    Returns void

setActivity

  • Sets the activity the client user is playing This will set the status to Online and set the AFK to false!

    example
    client.user.setActivity({ name: 'with Helly', type: ActivityType.Playing });
    example
    client.user.setActivity({ name: 'with Helly', type: 1 });

    Parameters

    Returns void

setPresence

  • Sets the presence of the client user

    example
    client.user.setPresence({ status: PresenceUpdateStatus.Online, activities: [{ name: 'Minecraft' }], afk: false });
    example
    client.user.setPresence({ status: 'idle', activities: [{ name: 'Games' }] });

    Parameters

    Returns void

setStatus

  • Sets the status of the client user This will clear your activity and set the AFK to false!

    example
    client.user.setStatus(PresenceUpdateStatus.Online);
    example
    client.user.setStatus('idle');

    Parameters

    Returns void

toString

  • toString(): string

  • Returns the mention of the user

    Returns string

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM