gluon
    Preparing search index...

    Class Invite

    Represents a guild invite.

    Implements

    • Invite
    Index

    Constructors

    constructor

    Accessors

    channel channelId code expires guild guildId id inviter inviterId maxUses url uses

    Methods

    [custom] toJSON toString getUrl shouldCache

    Constructors

    • Creates the structure for an invite.

      Parameters

      • client: Client

        The client instance.

      • data:
            | APIExtendedInvite
            | InviteCacheJSON
            | InviteDiscordJSON
            | InviteStorageJSON
            | GatewayInviteCreateDispatchData
            | GatewayInviteDeleteDispatchData

        The raw invite data from Discord.

      • options: { guildId: string; nocache?: boolean }

        Additional options for this structure.

        • guildId: string

          The id of the guild that the invite belongs to.

        • Optionalnocache?: boolean

          Whether this invite should be cached or not.

      Returns Invite

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

    Accessors

    • get channel(): null | AllChannels

      The channel the invite is directed to.

      Returns null | AllChannels

    • get channelId(): string

      The id of the channel the invite is directed to.

      Returns string

    • get expires(): undefined | number

      The UNIX timestamp of when the invite expires.

      Returns undefined | number

    • get guild(): null | Guild

      The guild that this role belongs to.

      Returns null | Guild

    • get guildId(): string

      The id of the guild that this invite belongs to.

      Returns string

    • get maxUses(): undefined | number

      The maximum number of uses allowed for the invite.

      Returns undefined | number

    • get uses(): undefined | number

      The number of times the invite has been used.

      Returns undefined | number

    Methods

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns
          | {
              channel: | undefined
              | GuildChannelDiscordJSON
              | GuildChannelStorageJSON
              | CategoryChannelCacheJSON
              | CategoryChannelStorageJSON;
              code: string;
              expires: undefined
              | number;
              expires_at?: undefined;
              inviter: UserCacheJSON | UserStorageJSON;
              max_uses: undefined | number;
              uses: undefined | number;
          }
          | {
              channel: | undefined
              | GuildChannelDiscordJSON
              | GuildChannelStorageJSON
              | CategoryChannelCacheJSON
              | CategoryChannelStorageJSON;
              code: string;
              expires?: undefined;
              expires_at: undefined
              | string;
              inviter: UserDiscordJSON;
              max_uses: undefined | number;
              uses: undefined | number;
          }

    • Returns the URL of the invite.

      Parameters

      • code: string

        The code of the invite.

      Returns string

    • Determines whether the invite should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods