GuildScheduledEvent | /src/structures/events/mod.ts | denocordts@1.2.0

class GuildScheduledEvent

import { GuildScheduledEvent } from "https://deno.land/x/denocordts@1.2.0/src/structures/events/mod.ts";

Constructors

new

GuildScheduledEvent(d: APIGuildScheduledEvent, client: Base)

Properties

channelId: string | null

the channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL

optional

creator: User

The User that created the scheduled Event

optional

creatorId: string | null

the id of the user that created the scheduled event

Note: creatorId will be null and creator will not be included for events created before October 25th, 2021, when the concept of creatorId was introduced and tracked.

optional

description: string | null

The description of the Event(1-1000 characters)

entityId: string | null

the id of an entity associated with a guild scheduled event

entityMetadata: APIGuildScheduledEvent["entity_metadata"]

additional metadata for the guild scheduled event

entityType: keyof GuildScheduledEventEntityType

The type of Scheduled Event

guildId: string

The GuildId which the scheduled event belongs to

id: string

The Id of the Scheduled Event

optional

image: string | null

the cover image hash of the scheduled event

name: string

The name of the Event (1-100 characters)

privacyLevel: keyof GuildScheduledEventPrivacyLevel

The privacy level of the Event

scheduledEndTime: string | null

the time the scheduled event will end, required if entityType is EXTERNAL

ISO8601 Timestamp

scheduledStartTime: string

The time scheduled Event will start

ISO8601 Timestamp

status: keyof GuildScheduledEventStatus

The Status of the Scheduled Event

optional

userCount: number

the number of users subscribed to the scheduled event