Skip to main content
Version: 0.37.81

APIExternalGuildScheduledEvent

Hierarchy

  • APIGuildScheduledEventBase<GuildScheduledEventEntityType.External>
    • APIExternalGuildScheduledEvent

Index

Properties

Properties

channel_id

channel_id: null

optionalcreator

creator?: APIUser

The user that created the scheduled event

optionalcreator_id

creator_id?: null | string

The id of the user that created the scheduled event

optionaldescription

description?: null | string

The description of the scheduled event

entity_id

entity_id: null | string

The id of the hosting entity associated with the scheduled event

entity_metadata

entity_metadata: Required<APIGuildScheduledEventEntityMetadata>

entity_type

entity_type: External

The type of hosting entity associated with the scheduled event

guild_id

guild_id: string

The guild id which the scheduled event belongs to

id

id: string

The id of the guild event

optionalimage

image?: null | string

The cover image of the scheduled event

name

name: string

The name of the scheduled event

privacy_level

privacy_level: GuildOnly

The privacy level of the scheduled event

scheduled_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

scheduled_start_time

scheduled_start_time: string

The time the scheduled event will start

status

status: GuildScheduledEventStatus

The status of the scheduled event

optionaluser_count

user_count?: number

The number of users subscribed to the scheduled event