gluon
    Preparing search index...

    Class User

    Represents a Discord user.

    https://discord.com/developers/docs/resources/user

    Implements

    • User
    Index

    Constructors

    constructor

    Accessors

    _cached _originalAvatarHash avatarIsAnimated bot createdTimestamp discriminator displayAvatarURL globalName hasAvatar id mention tag username

    Methods

    [custom] overrideAvatarURL toJSON toString getAvatarUrl getMention shouldCache

    Constructors

    • Creates a structure for a user.

      Parameters

      • client: Client

        The client instance.

      • data: APIUser | UserCacheJSON | UserDiscordJSON | UserStorageJSON

        The raw user data.

      • options: { nocache?: boolean } = ...

        Additional options for this structure.

        • Optionalnocache?: boolean

          Whether the user should be cached or not.

      Returns User

      https://discord.com/developers/docs/resources/user#user-object

    Accessors

    _cached

    • get _cached(): number

      The UNIX (seconds) timestamp when this user was last cached.

      Returns number

    _originalAvatarHash

    • get _originalAvatarHash(): null | string

      The hash of the users's avatar, as it was received from Discord.

      Returns null | string

    • get avatarIsAnimated(): boolean

      Whether the user has an animated avatar or not.

      Returns boolean

    • get bot(): boolean

      Whether the user is a bot or not.

      Returns boolean

    • get createdTimestamp(): number

      The UNIX (seconds) timestamp of when this user created their Discord account.

      Returns number

    • get discriminator(): null | string

      The discriminator of the user.

      Returns null | string

    • get displayAvatarURL(): any

      The avatar URL of the user.

      Returns any

    • get globalName(): null | string

      The global name of the user.

      Returns null | string

    • get hasAvatar(): boolean

      Whether the user has an avatar or not.

      Returns boolean

    • get mention(): string

      The mention string for the user.

      Returns string

    • get tag(): string

      The username of the user, including their discriminator if they are a bot (username#0001).

      Returns string

    • get username(): string

      The username of the user.

      Returns string

    Methods

    • Overrides the user's avatar with a custom URL.

      Parameters

      • url: string

        The URL of the avatar to override the user's avatar with.

      Returns void

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns
          | {
              _cached: number;
              avatar: null
              | string;
              bot: boolean;
              discriminator: undefined | number;
              global_name: null | string;
              id: string;
              username: string;
          }
          | {
              _cached?: undefined;
              avatar: null
              | string;
              bot: boolean;
              discriminator: null | string;
              global_name: null | string;
              id: string;
              username: string;
          }

    • Returns the URL to the user's avatar.

      Parameters

      • id: string

        The ID of the user to get the avatar for.

      • Optionalhash: null | string

        The hash of the avatar.

      Returns string

    • Returns a mention string for the user.

      Parameters

      • id: string

        The ID of the user to mention.

      Returns string

    • Determines whether the user should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods