@typed-discord/rest
    Preparing search index...

    Interface ExternalScheduledEventResponse

    interface ExternalScheduledEventResponse {
        channel_id: `${bigint}` | null;
        creator?: UserResponse;
        creator_id: `${bigint}` | null;
        description: string | null;
        entity_id: `${bigint}` | null;
        entity_metadata: EntityMetadataExternalResponse;
        entity_type: EXTERNAL;
        guild_id: `${bigint}`;
        guild_scheduled_event_exceptions: GuildScheduledEventExceptionResponse[];
        id: `${bigint}`;
        image: string | null;
        name: string;
        privacy_level: GUILD_ONLY;
        recurrence_rule: RecurrenceRuleResponse | null;
        scheduled_end_time: string | null;
        scheduled_start_time: string;
        status: GuildScheduledEventStatuses;
        user_count?: number;
        user_rsvp?: ScheduledEventUserResponse | null;
    }
    Index

    Properties

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

    Properties

    channel_id: `${bigint}` | null

    Channel ID in which the scheduled event will be hosted, or null if entity type is EXTERNAL

    creator?: UserResponse

    User that created the scheduled event

    creator_id: `${bigint}` | null

    ID of the user that created the scheduled event

    description: string | null

    Description of the scheduled event

    entity_id: `${bigint}` | null

    ID of the hosting entity associated with the scheduled event

    entity_metadata: EntityMetadataExternalResponse
    entity_type: EXTERNAL

    Type of hosting entity associated with the scheduled event

    guild_id: `${bigint}`

    ID of the guild the scheduled event belongs to

    guild_scheduled_event_exceptions: GuildScheduledEventExceptionResponse[]
    id: `${bigint}`

    ID of the scheduled event

    image: string | null

    Cover image hash of the scheduled event

    name: string

    Name of the scheduled event

    privacy_level: GUILD_ONLY

    Privacy level of the scheduled event

    recurrence_rule: RecurrenceRuleResponse | null

    Recurrence rule for the scheduled event, or null if not recurring

    scheduled_end_time: string | null

    When the scheduled event will end, or null if no end time

    scheduled_start_time: string

    When the scheduled event will start

    status: GuildScheduledEventStatuses

    Status of the scheduled event

    user_count?: number

    Number of users subscribed to the scheduled event

    user_rsvp?: ScheduledEventUserResponse | null

    Settings

    Member Visibility

    On This Page

    Properties