Interface CreateScheduledEventOptions

interface CreateScheduledEventOptions {
    channelID?: string;
    description?: string;
    entityMetadata?: {
        location?: string;
    };
    entityType: GuildScheduledEventEntityTypes;
    image?: string | Buffer;
    name: string;
    privacyLevel: GUILD_ONLY;
    reason?: string;
    scheduledEndTime?: string;
    scheduledStartTime: string;
}

Properties

channelID? description? entityMetadata? entityType image? name privacyLevel reason? scheduledEndTime? scheduledStartTime

Properties

Optional channelID

channelID?: string

The ID of the stage channel the event is taking place in. Optional if entityType is EXTERNAL.

Optional description

description?: string

The description of the event.

Optional entityMetadata

entityMetadata?: {
    location?: string;
}

The metadata for the entity.

Type declaration

  • Optional location?: string

    The location of the event. Required if entityType is EXTERNAL.

entityType

entityType: GuildScheduledEventEntityTypes

The type of the event.

Optional image

image?: string | Buffer

The cover image of the event (buffer, or full data url).

name

name: string

The name of the scheduled event.

privacyLevel

privacyLevel: GUILD_ONLY

The privacy level of the event.

Optional reason

reason?: string

The reason for creating the scheduled event.

Optional scheduledEndTime

scheduledEndTime?: string

The time the event ends. ISO8601 Timestamp. Required if entityType is EXTERNAL.

scheduledStartTime

scheduledStartTime: string

The time the event starts. ISO8601 Timestamp.

Settings

Member Visibility

Theme

On This Page

channelIDdescriptionentityMetadataentityTypeimagenameprivacyLevelreasonscheduledEndTimescheduledStartTime