Interface PartialGuildScheduledEvent

interface PartialGuildScheduledEvent {
    channel: null | StageChannel | VoiceChannel;
    channelId: null | string;
    client: Client<true>;
    createdAt: Date;
    createdTimestamp: number;
    creator: null | User;
    creatorId: null | string;
    description: null | string;
    entityId: null | string;
    entityMetadata: null | GuildScheduledEventEntityMetadata;
    entityType: null | GuildScheduledEventEntityType;
    guild: null | Guild;
    guildId: string;
    id: string;
    image: null | string;
    name: null | string;
    partial: true;
    privacyLevel: null | GuildOnly;
    recurrenceRule: null | GuildScheduledEventRecurrenceRule;
    scheduledEndAt: null | Date;
    scheduledEndTimestamp: null | number;
    scheduledStartAt: null | Date;
    scheduledStartTimestamp: null | number;
    status: null | GuildScheduledEventStatus;
    url: string;
    userCount: null;
    coverImageURL(options?: Readonly<BaseImageURLOptions>): null | string;
    createInviteURL(
        options?: GuildScheduledEventInviteURLCreateOptions,
    ): Promise<string>;
    delete(): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    edit<AcceptableStatus extends Active | Completed | Canceled>(
        options: GuildScheduledEventEditOptions<
            GuildScheduledEventStatus,
            AcceptableStatus,
        >,
    ): Promise<GuildScheduledEvent<AcceptableStatus>>;
    fetch(
        force?: boolean,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    fetchSubscribers<
        Options extends FetchGuildScheduledEventSubscribersOptions,
    >(
        options?: Options,
    ): Promise<GuildScheduledEventManagerFetchSubscribersResult<Options>>;
    isActive(): this is GuildScheduledEvent<Active>;
    isCanceled(): this is GuildScheduledEvent<Canceled>;
    isCompleted(): this is GuildScheduledEvent<Completed>;
    isScheduled(): this is GuildScheduledEvent<Scheduled>;
    setDescription(
        description: string,
        reason?: string,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    setLocation(
        location: string,
        reason?: string,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    setName(
        name: string,
        reason?: string,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    setScheduledEndTime(
        scheduledEndTime: DateResolvable,
        reason?: string,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    setScheduledStartTime(
        scheduledStartTime: DateResolvable,
        reason?: string,
    ): Promise<GuildScheduledEvent<GuildScheduledEventStatus>>;
    setStatus<AcceptableStatus extends Active | Completed | Canceled>(
        status: AcceptableStatus,
        reason?: string,
    ): Promise<GuildScheduledEvent<AcceptableStatus>>;
    toJSON(...props: Record<string, string | boolean>[]): unknown;
    toString(): string;
    valueOf(): string;
}

Hierarchy (View Summary)

  • Partialize<
        GuildScheduledEvent,
        "userCount",
        "status"
        | "privacyLevel"
        | "name"
        | "entityType",
    >
    • PartialGuildScheduledEvent

Properties

channel channelId client createdAt createdTimestamp creator creatorId description entityId entityMetadata entityType guild guildId id image name partial privacyLevel recurrenceRule scheduledEndAt scheduledEndTimestamp scheduledStartAt scheduledStartTimestamp status url userCount

Methods

coverImageURL createInviteURL delete edit fetch fetchSubscribers isActive isCanceled isCompleted isScheduled setDescription setLocation setName setScheduledEndTime setScheduledStartTime setStatus toJSON toString valueOf

Properties

channel

channel: null | StageChannel | VoiceChannel

channelId

channelId: null | string

Readonlyclient

client: Client<true>

createdAt

createdAt: Date

createdTimestamp

createdTimestamp: number

creator

creator: null | User

creatorId

creatorId: null | string

description

description: null | string

entityId

entityId: null | string

entityMetadata

entityMetadata: null | GuildScheduledEventEntityMetadata

entityType

entityType: null | GuildScheduledEventEntityType

guild

guild: null | Guild

guildId

guildId: string

id

id: string

image

image: null | string

name

name: null | string

partial

partial: true

privacyLevel

privacyLevel: null | GuildOnly

recurrenceRule

recurrenceRule: null | GuildScheduledEventRecurrenceRule

scheduledEndAt

scheduledEndAt: null | Date

scheduledEndTimestamp

scheduledEndTimestamp: null | number

scheduledStartAt

scheduledStartAt: null | Date

scheduledStartTimestamp

scheduledStartTimestamp: null | number

status

status: null | GuildScheduledEventStatus

url

url: string

userCount

userCount: null

Methods

coverImageURL

createInviteURL

delete

edit

fetch

fetchSubscribers

isActive

isCanceled

isCompleted

isScheduled

setDescription

setLocation

setName

setScheduledEndTime

setScheduledStartTime

setStatus

toJSON

  • toJSON(...props: Record<string, string | boolean>[]): unknown

    Parameters

    • ...props: Record<string, string | boolean>[]

    Returns unknown

toString

  • toString(): string

    Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): string

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods