core

interface APIGuildScheduledEventBase

external
export interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>

Type Parameters

external
channel_id : Snowflake | null

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

optionalexternal
creator_id? : Snowflake | null

The id of the user that created the scheduled event

optionalexternal
creator? : APIUser

The user that created the scheduled event

optionalexternal
description? : string | null

The description of the scheduled event

external
entity_id : Snowflake | null

The id of the hosting entity associated with the scheduled event

external
entity_metadata : APIGuildScheduledEventEntityMetadata | null

The entity metadata for the scheduled event

external
entity_type : Type

The type of hosting entity associated with the scheduled event

external
guild_id : Snowflake

The guild id which the scheduled event belongs to

external
id : Snowflake

The id of the guild event

optionalexternal
image? : string | null

The cover image of the scheduled event

external
name : string

The name of the scheduled event

external
privacy_level : GuildScheduledEventPrivacyLevel

The privacy level of the scheduled event

external
recurrence_rule : APIGuildScheduledEventRecurrenceRule | null

The definition for how often this event should recur

external
scheduled_end_time : string | null

The time at which the guild event will end, or null if the event does not have a scheduled time to end

external
scheduled_start_time : string

The time the scheduled event will start

external
status : GuildScheduledEventStatus

The status of the scheduled event

optionalexternal
user_count? : number

The number of users subscribed to the scheduled event