Class GuildScheduledEvent<Status>

channelId

creator

creatorId

description

entityId

entityMetadata

entityType

guildId

id

image

name

privacyLevel

recurrenceRule

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?: Readonly<BaseImageURLOptions>): null | string

  Parameters

  • Optionaloptions: Readonly<BaseImageURLOptions>

  Returns null | string

createInviteURL

• createInviteURL(
      options?: GuildScheduledEventInviteURLCreateOptions,
  ): Promise<string>

  Parameters

  • Optionaloptions: GuildScheduledEventInviteURLCreateOptions

  Returns Promise<string>

delete

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

  Returns Promise<GuildScheduledEvent<Status>>

edit

• edit<AcceptableStatus extends Active | Completed | Canceled>(
      options: GuildScheduledEventEditOptions<Status, AcceptableStatus>,
  ): Promise<GuildScheduledEvent<AcceptableStatus>>

  Type Parameters

  • AcceptableStatus extends Active | Completed | Canceled

  Parameters

  • options: GuildScheduledEventEditOptions<Status, AcceptableStatus>

  Returns Promise<GuildScheduledEvent<AcceptableStatus>>

fetch

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

  Parameters

  • Optionalforce: boolean

  Returns Promise<GuildScheduledEvent<Status>>

fetchSubscribers

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

  Type Parameters

  • Options extends FetchGuildScheduledEventSubscribersOptions

  Parameters

  • Optionaloptions: 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: string,
      reason?: string,
  ): Promise<GuildScheduledEvent<Status>>

  Parameters

  • description: string
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<Status>>

setLocation

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

  Parameters

  • location: string
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<Status>>

setName

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

  Parameters

  • name: string
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<Status>>

setScheduledEndTime

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

  Parameters

  • scheduledEndTime: DateResolvable
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<Status>>

setScheduledStartTime

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

  Parameters

  • scheduledStartTime: DateResolvable
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<Status>>

setStatus

• setStatus<AcceptableStatus extends Active | Completed | Canceled>(
      status: AcceptableStatus,
      reason?: string,
  ): Promise<GuildScheduledEvent<AcceptableStatus>>

  Type Parameters

  • AcceptableStatus extends Active | Completed | Canceled

  Parameters

  • status: AcceptableStatus
  • Optionalreason: string

  Returns Promise<GuildScheduledEvent<AcceptableStatus>>

toString

• toString(): string

  Returns a string representation of an object.

  Returns string