Skip to content

GuildScheduledEvent

Represents a Discord guild scheduled event. The REST routes already existed, but the payloads were only returned as raw camel-cased objects from gateway hooks. This structure centralizes date parsing, lifecycle helpers, subscriber listing, and guild-scoped CRUD. https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure

Signature

@Mixins(DiscordBase)export declare class GuildScheduledEvent extends DiscordBase<APIGuildScheduledEvent>

Properties

startAtGetter
get startAt(): Date | undefined;

The start time of the event as a `Date`.

endAtGetter
get endAt(): Date | undefined;

The end time of the event as a `Date`, when Discord provides one.

get isExternal(): boolean;

Whether the event takes place outside Discord (no channel).

get createdTimestamp(): number;

Create a timestamp for the current object.

get createdAt(): Date;

createdAt gets the creation Date instace of the current object.

image?: string | null | undefined;

Methods

delete(reason?: string): Promise<undefined>;

Deletes this event.

static methods({ client, guildId }: MethodContext<{    guildId: string;}>): {    list: (query?: RESTGetAPIGuildScheduledEventsQuery) => Promise<GuildScheduledEventStructure[]>;    create: (body: RESTPostAPIGuildScheduledEventJSONBody, reason?: string) => Promise<GuildScheduledEventStructure>;    fetch: (eventId: string, query?: RESTGetAPIGuildScheduledEventQuery) => Promise<GuildScheduledEventStructure>;    edit: (eventId: string, body: RESTPatchAPIGuildScheduledEventJSONBody, reason?: string) => Promise<GuildScheduledEventStructure>;    delete: (eventId: string, reason?: string) => Promise<undefined>;    subscribers: (eventId: string, query?: RESTGetAPIGuildScheduledEventUsersQuery) => Promise<GuildScheduledSubscriberStructure[]>;};