Class GuildScheduledEvent

constructor

• new GuildScheduledEvent(data, client): GuildScheduledEvent

• Parameters

  • data: RawScheduledEvent
  • client: Client<ClientEvents>

  Returns GuildScheduledEvent

channelID

Optional creator

Optional description

entityID

entityMetadata

entityType

exceptions

guildID

image

name

privacyLevel

scheduledEndTime

scheduledStartTime

status

userCount

channel

• get channel(): undefined | null | StageChannel

• The channel in which the event will be hosted. null if entityType is EXTERNAL

  Returns undefined | null | StageChannel

guild

• get guild(): Guild

• The guild this scheduled event belongs to. This will throw an error if the guild is not cached.

  Returns Guild

createException

• createException(options): Promise<ScheduledEventException>

• Create an exception to the recurrence rule for this scheduled event.

  Parameters

  • options: CreateScheduledEventExceptionOptions

    The options for creating the scheduled event exception.

  Returns Promise<ScheduledEventException>

  Caching

  This method may cache its result.

  Caches

  GuildScheduledEvent#exceptions

deleteException

• deleteException(exceptionID, reason?): Promise<void>

• Delete an exception to the recurrence rule for this scheduled event.

  Parameters

  • exceptionID: string

    The ID of the scheduled event exception.
  • Optional reason: string

    The reason for deleting the scheduled event exception.

  Returns Promise<void>

  Caching

  This method may remove the result from cache.

  Caches

  GuildScheduledEvent#exceptions

deleteScheduledEvent

• deleteScheduledEvent(reason?): Promise<void>

• Delete this scheduled event.

  Parameters

  • Optional reason: string

    The reason for deleting the scheduled event. Discord's docs do not explicitly state a reason can be provided, so it may not be used.

  Returns Promise<void>

editException

• editException(exceptionID, options): Promise<ScheduledEventException>

• Edit an exception to the recurrence rule for this scheduled event.

  Parameters

  • exceptionID: string

    The ID of the scheduled event exception.
  • options: EditScheduledEventExceptionOptions

    The options for editing the scheduled event exception.

  Returns Promise<ScheduledEventException>

  Caching

  This method may cache its result.

  Caches

  GuildScheduledEvent#exceptions

getExceptionUsers

• getExceptionUsers(exceptionID, options?): Promise<ScheduledEventUser[]>

• Get users subscribed to an exception for this scheduled event.

  Parameters

  • exceptionID: string

    The ID of the scheduled event exception.
  • Optional options: GetScheduledEventUsersOptions

    The options for getting the users.

  Returns Promise<ScheduledEventUser[]>

  Caching

  This method does cache part of its result. Members will not be cached if the guild is not cached.

  Caches

  Client#users
  Guild#members

getUserCounts

• getUserCounts(options?): Promise<ScheduledEventUserCounts>

• Get user counts for this scheduled event and optionally specific exceptions.

  Parameters

  • Optional options: GetScheduledEventUserCountsOptions

    The options for getting the user counts.

  Returns Promise<ScheduledEventUserCounts>

  Caching

  This method may cache the event user count.

  Caches

  GuildScheduledEvent#userCount

getUsers

• getUsers(options?): Promise<ScheduledEventUser[]>

• Get users subscribed to this scheduled event.

  Parameters

  • Optional options: GetScheduledEventUsersOptions

    The options for getting the users.

  Returns Promise<ScheduledEventUser[]>

  Caching

  This method does cache part of its result. Members will not be cached if the guild is not cached.

  Caches

  Client#users
  Guild#members

imageURL

• imageURL(format?, size?): null | string

• The url of this event's cover image.

  Parameters

  • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

    The format of the image.
  • Optional size: number

    The size of the image.

  Returns null | string

toJSON

• toJSON(): JSONScheduledEvent

• Returns JSONScheduledEvent