GuildScheduledEvent

GuildScheduledEvent

Represents a guild scheduled event

Constructor

new GuildScheduledEvent()

Properties:
Properties
Name Type Attributes Description
channel VoiceChannel | StageChannel | Object <nullable>

The channel where the event will be held. This will be null if the event is external (entityType is 3). Can be partial with only id if the channel or guild is not cached
creator User <nullable>

The user that created the scheduled event. For events created before October 25 2021, this will be null. Please see the relevant Discord documentation for more details
description String <nullable>

The description of the event
entityID String <nullable>

The entity ID associated to the event
entityMetadata Object <nullable>

Metadata for the event. This will be null if the event is not external (entityType is not 3)
Name Type Attributes Description
location String <nullable>

Location of the event
entityType Number

The entity type of the scheduled event

guild Guild | Object

The guild which the event belongs to. Can be partial with only id if not cached

id String

The ID of the guild event

image String <nullable>

The hash of the event's image, or null if no image

imageURL String <nullable>

The URL of the event's image, or null if no image

name String

The name of the event

privacyLevel Number

Event privacy level

recurrenceRule Object <nullable>

The definitions for how often this event should recur. Note: properties have been camelCased, and ISO8601 timestamps are represented by epoch number.

scheduledStartTime Number

The time the event will start

scheduledEndTime Number <nullable>

The time the event will end, or null if the event does not have a scheduled time to end

status Number

The status of the scheduled event

userCount Number <nullable>

The number of users subscribed to the event

Source:

Methods

delete() → {Promise}

Delete this scheduled event

Source:
Returns:
Type:
Promise

edit(event, reasonopt) → {Promise.<GuildScheduledEvent>}

Edit this scheduled event

Source:
Parameters:
Name Type Attributes Description
event Object

The new guild scheduled event object

Name Type Attributes Description
channelID String <optional>

The channel ID of the event. If updating entityType to 3 (external), this must be set to null
description String <optional>

The description of the event
entityMetadata Object <optional>

The entity metadata for the scheduled event. This is required if updating entityType to 3 (external)

Name Type Attributes Description
location String <optional>

Location of the event. This is required if updating entityType to 3 (external)
entityType Number <optional>

The entity type of the scheduled event
image String <optional>

Base 64 encoded image for the event
name String <optional>

The name of the event
privacyLevel String <optional>

The privacy level of the event
recurrenceRule Object <optional>
<nullable>

The definitions for how often this event should recur. Properties can be camelCase (preferred) or snake_case
scheduledEndTime Date <optional>

The time when the scheduled event is scheduled to end. This is required if updating entityType to 3 (external)
scheduledStartTime Date <optional>

The time the event will start
status Number <optional>

The status of the scheduled event
reason String <optional>

The reason to be displayed in audit logs
Returns:
Type:
Promise.<GuildScheduledEvent>

getUsers(optionsopt)

Get a list of users subscribed to the guild scheduled event

Source:
Parameters:
Name Type Attributes Description
options Object <optional>

Options for the request

Name Type Attributes Default Description
after String <optional>

Get users after this user ID. If options.before is provided, this will be ignored. Fetching users in between before and after is not supported
before String <optional>

Get users before this user ID
limit Number <optional>
 100

The number of users to get (max 100). Pagination will only work if one of options.after or options.after is also provided
withMember Boolean <optional>

Include guild member data
Returns: