Interface PartialGuildScheduledEvent

channel

channelId

Readonly client

createdAt

createdTimestamp

creator

creatorId

description

entityId

entityMetadata

entityType

guild

guildId

id

image

name

partial

privacyLevel

scheduledEndAt

scheduledEndTimestamp

scheduledStartAt

scheduledStartTimestamp

status

url

userCount

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<GuildScheduledEventStatus>>

• Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

edit

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

• Type Parameters

  • AcceptableStatus extends Active | Completed | Canceled

  Parameters

  • options: GuildScheduledEventEditOptions<GuildScheduledEventStatus, AcceptableStatus>

  Returns Promise<GuildScheduledEvent<AcceptableStatus>>

fetch

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

• Parameters

  • Optional force: boolean

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

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<GuildScheduledEventStatus>>

• Parameters

  • description: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

setLocation

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

• Parameters

  • location: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

setName

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

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

setScheduledEndTime

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

• Parameters

  • scheduledEndTime: DateResolvable

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

setScheduledStartTime

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

• Parameters

  • scheduledStartTime: DateResolvable

  • Optional reason: string

  Returns Promise<GuildScheduledEvent<GuildScheduledEventStatus>>

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>>

toJSON

• toJSON(...props): unknown

• Parameters

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

  Returns unknown

toString

• toString(): string

• Returns string

valueOf

• valueOf(): string

• Returns string