gluon
    Preparing search index...

    Class ScheduledEvent

    Represents an scheduled event.

    https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure

    Implements

    • ScheduledEvent
    Index

    Constructors

    constructor

    Accessors

    _originalImageHash creator creatorId description displayImageURL entityType guild guildId id location name scheduledEndTime scheduledStartTime status userCount

    Methods

    _decrementUserCount _incrementUserCount [custom] toJSON toString getImageUrl shouldCache

    Constructors

    • Creates the structure for a scheduled event.

      Parameters

      • client: Client

        The client instance.

      • data:
            | APIGuildScheduledEvent
            | ScheduledEventCacheJSON
            | ScheduledEventDiscordJSON
            | ScheduledEventStorageJSON

        Scheduled event data from Discord.

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

        Additional options for this structure.

        • guildId: string

          The ID of the guild that this event belongs to.

        • Optionalnocache?: boolean

          Whether this event should be cached or not.

      Returns ScheduledEvent

    Accessors

    _originalImageHash

    • get _originalImageHash(): null | string

      The hash of the event's image, as it was received from Discord.

      Returns null | string

    • get creatorId(): null | string

      The ID of the user who created the event.

      Returns null | string

    • get displayImageURL(): null | string

      The url of the events's image.

      Returns null | string

    • get entityType(): GuildScheduledEventEntityType

      Where the event is scheduled to take place.

      Returns GuildScheduledEventEntityType

    • get scheduledEndTime(): null | number

      The UNIX timestamp of the end time for the event.

      Returns null | number

    • get scheduledStartTime(): number

      The UNIX timestamp of the start time for the event.

      Returns number

    • get status(): GuildScheduledEventStatus

      The status of the event.

      Returns GuildScheduledEventStatus

    • get userCount(): number

      The number of users who have signed up for the event.

      Returns number

    Methods

    _decrementUserCount

    _incrementUserCount

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns
          | {
              creator: UserCacheJSON
              | UserStorageJSON;
              creator_id: undefined | string;
              description: undefined | string;
              entity_metadata: { location: string };
              entity_type: GuildScheduledEventEntityType;
              guild_id: string;
              id: string;
              image: null | string;
              name: string;
              scheduled_end_time: null | number;
              scheduled_start_time: number;
              status: GuildScheduledEventStatus;
              user_count: number;
          }
          | {
              creator: UserDiscordJSON;
              creator_id: undefined
              | string;
              description: undefined | string;
              entity_metadata: { location: string };
              entity_type: GuildScheduledEventEntityType;
              guild_id: string;
              id: string;
              image: null | string;
              name: string;
              scheduled_end_time: null | string;
              scheduled_start_time: string;
              status: GuildScheduledEventStatus;
              user_count: number;
          }

    • Returns the URL of the event's image.

      Parameters

      • id: string

        The id of the event.

      • Optionalhash: null | string

        The hash of the event's image.

      Returns null | string

    • Determines whether the scheduled event 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