Class GuildScheduledEvent<Status>

channelId

creator

creatorId

description

entityId

entityMetadata

entityType

guildId

id

image

name

privacyLevel

scheduledEndTimestamp

scheduledStartTimestamp

status

userCount

channel

• get channel(): null | StageChannel | VoiceChannel

• Returns null | StageChannel | VoiceChannel

createdAt

• get createdAt(): Date

• Returns Date

createdTimestamp

• get createdTimestamp(): number

• Returns number

guild

• get guild(): null | Guild

• Returns null | Guild

partial

• get partial(): false

• Returns false

scheduledEndAt

• get scheduledEndAt(): null | Date

• Returns null | Date

scheduledStartAt

• get scheduledStartAt(): null | Date

• Returns null | Date

url

• get url(): string

• Returns string

coverImageURL

• coverImageURL(options?): null | string

• Parameters

  • Optional options: Readonly<BaseImageURLOptions>

  Returns null | string

createInviteURL

• createInviteURL(options?): Promise<string>

• Parameters

  • Optional options: GuildScheduledEventInviteURLCreateOptions

  Returns Promise<string>

delete

• delete(): Promise<GuildScheduledEvent<Status>>

• Returns Promise<GuildScheduledEvent<Status>>

edit

• edit<AcceptableStatus>(options): Promise<GuildScheduledEvent<AcceptableStatus>>

• Type Parameters

  • AcceptableStatus extends Active | Completed | Canceled

  Parameters

  • options: GuildScheduledEventEditOptions<Status, AcceptableStatus>

  Returns Promise<GuildScheduledEvent<AcceptableStatus>>

fetch

• fetch(force?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • Optional force: boolean

  Returns Promise<GuildScheduledEvent<Status>>

fetchSubscribers

• fetchSubscribers<Options>(options?): Promise<GuildScheduledEventManagerFetchSubscribersResult<Options>>

• Type Parameters

  • Options extends FetchGuildScheduledEventSubscribersOptions

  Parameters

  • Optional options: Options

  Returns Promise<GuildScheduledEventManagerFetchSubscribersResult<Options>>

isActive

• isActive(): this is GuildScheduledEvent<Active>

• Returns this is GuildScheduledEvent<Active>

isCanceled

• isCanceled(): this is GuildScheduledEvent<Canceled>

• Returns this is GuildScheduledEvent<Canceled>

isCompleted

• isCompleted(): this is GuildScheduledEvent<Completed>

• Returns this is GuildScheduledEvent<Completed>

isScheduled

• isScheduled(): this is GuildScheduledEvent<Scheduled>

• Returns this is GuildScheduledEvent<Scheduled>

setDescription

• setDescription(description, reason?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • description: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<Status>>

setLocation

• setLocation(location, reason?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • location: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<Status>>

setName

• setName(name, reason?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<Status>>

setScheduledEndTime

• setScheduledEndTime(scheduledEndTime, reason?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • scheduledEndTime: DateResolvable

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<Status>>

setScheduledStartTime

• setScheduledStartTime(scheduledStartTime, reason?): Promise<GuildScheduledEvent<Status>>

• Parameters

  • scheduledStartTime: DateResolvable

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<Status>>

setStatus

• setStatus<AcceptableStatus>(status, reason?): Promise<GuildScheduledEvent<AcceptableStatus>>

• Type Parameters

  • AcceptableStatus extends Active | Completed | Canceled

  Parameters

  • status: AcceptableStatus

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<AcceptableStatus>>

toString

• toString(): string

• Returns string