Discord.https - v3.0.16
    Preparing search index...

    Interface APIExternalGuildScheduledEvent

    interface APIExternalGuildScheduledEvent {
        channel_id: null;
        creator?: APIUser;
        creator_id?: null | string;
        description?: null | string;
        entity_id: null | string;
        entity_metadata: Required<APIGuildScheduledEventEntityMetadata>;
        entity_type: External;
        guild_id: string;
        id: string;
        image?: null | string;
        name: string;
        privacy_level: GuildOnly;
        recurrence_rule: null | APIGuildScheduledEventRecurrenceRule;
        scheduled_end_time: null | string;
        scheduled_start_time: string;
        status: GuildScheduledEventStatus;
        user_count?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    channel_id creator? creator_id? description? entity_id entity_metadata entity_type guild_id id image? name privacy_level recurrence_rule scheduled_end_time scheduled_start_time status user_count?

    Properties

    channel_id: null

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

    creator?: APIUser

    The user that created the scheduled event

    creator_id?: null | string

    The id of the user that created the scheduled event

    description?: null | string

    The description of the scheduled event

    entity_id: null | string

    The id of the hosting entity associated with the scheduled event

    entity_metadata: Required<APIGuildScheduledEventEntityMetadata>

    The entity metadata for the scheduled event

    entity_type: External

    The type of hosting entity associated with the scheduled event

    guild_id: string

    The guild id which the scheduled event belongs to

    id: string

    The id of the guild event

    image?: null | string

    The cover image of the scheduled event

    name: string

    The name of the scheduled event

    privacy_level: GuildOnly

    The privacy level of the scheduled event

    recurrence_rule: null | APIGuildScheduledEventRecurrenceRule

    The definition for how often this event should recur

    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: 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

    Settings

    Member Visibility

    On This Page

    Properties