APIGuildScheduledEventBase

export interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType> 
export interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>

No summary provided.

NameConstraintsOptionalDefaultDescription
TypeGuildScheduledEventEntityTypeNoNone
channel_id:Snowflake | null
The channel id in which the scheduled event will be hosted, or null if entity type is EXTERNAL
creator_id?:Snowflake | null
The id of the user that created the scheduled event
creator?:APIUser
The user that created the scheduled event
description?:string | null
The description of the scheduled event
entity_id:Snowflake | null
The id of the hosting entity associated with the scheduled event
entity_metadata:APIGuildScheduledEventEntityMetadata | null
The entity metadata for the scheduled event
entity_type:Type
The type of hosting entity associated with the scheduled event
guild_id:Snowflake
The guild id which the scheduled event belongs to
id:Snowflake
The id of the guild event
image?:string | null
The cover image of the scheduled event
name:string
The name of the scheduled event
privacy_level:GuildScheduledEventPrivacyLevel
The privacy level of the scheduled event
recurrence_rule:APIGuildScheduledEventRecurrenceRule | null
The definition for how often this event should recur
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
scheduled_start_time:string
The time the scheduled event will start
status:GuildScheduledEventStatus
The status of the scheduled event
user_count?:number
The number of users subscribed to the scheduled event