Skip to main content
Version: Next

APIExternalGuildScheduledEvent

Hierarchy

  • APIGuildScheduledEventBase<GuildScheduledEventEntityType.External>
    • APIExternalGuildScheduledEvent

Index

Properties

Properties

channel_id

channel_id: null

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

optionalinheritedcreator

creator?: APIUser

The user that created the scheduled event

optionalinheritedcreator_id

creator_id?: null | string

The id of the user that created the scheduled event

optionalinheriteddescription

description?: null | string

The description of the scheduled event

inheritedentity_id

entity_id: null | string

The id of the hosting entity associated with the scheduled event

entity_metadata

entity_metadata: Required<APIGuildScheduledEventEntityMetadata>

The entity metadata for the scheduled event

inheritedentity_type

entity_type: External

The type of hosting entity associated with the scheduled event

inheritedguild_id

guild_id: string

The guild id which the scheduled event belongs to

inheritedid

id: string

The id of the guild event

optionalinheritedimage

image?: null | string

The cover image of the scheduled event

inheritedname

name: string

The name of the scheduled event

inheritedprivacy_level

privacy_level: GuildScheduledEventPrivacyLevel

The privacy level of the scheduled event

inheritedrecurrence_rule

recurrence_rule: null | APIGuildScheduledEventRecurrenceRule

The definition for how often this event should recur

inheritedscheduled_end_time

scheduled_end_time: null | string

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

inheritedscheduled_start_time

scheduled_start_time: string

The time the scheduled event will start

inheritedstatus

status: GuildScheduledEventStatus

The status of the scheduled event

optionalinheriteduser_count

user_count?: number

The number of users subscribed to the scheduled event

Page Options