discord.js | GuildScheduledEvent

Search...

GuildScheduledEvent

export class GuildScheduledEvent<S extends GuildScheduledEventStatus = GuildScheduledEventStatus> extends Base

export class GuildScheduledEvent<S extends GuildScheduledEventStatus = GuildScheduledEventStatus> extends Base

Represents a scheduled event in a Guild.

Extends

Base

Name	Constraints	Optional	Default	Description
S	GuildScheduledEventStatus	Yes	GuildScheduledEventStatus	None

Readonly

channel:VoiceChannel | StageChannel | null

The channel associated with this scheduled event

channelId:Snowflake | null

The channel id in which the scheduled event will be hosted, or null if entity type is

Readonly

client:Client<true>

The client that instantiated this

Inherited from Base

Readonly

createdAt:Date

The time the guild scheduled event was created at

Readonly

createdTimestamp:number

The timestamp the guild scheduled event was created at

creator:User | null

The user that created this guild scheduled event

creatorId:Snowflake | null

The id of the user that created this guild scheduled event

description:string | null

The description of the guild scheduled event

entityId:Snowflake | null

The id of the hosting entity associated with the scheduled event

entityMetadata:GuildScheduledEventEntityMetadata | null

Additional metadata

entityType:GuildScheduledEventEntityType

The type of hosting entity associated with the scheduled event

Readonly

guild:Guild | null

The guild this scheduled event belongs to

guildId:Snowflake

The id of the guild this guild scheduled event belongs to

id:Snowflake

The id of the guild scheduled event

image:string | null

The cover image hash for this scheduled event

name:string

The name of the guild scheduled event

Readonly

partial:false

Whether this guild scheduled event is partial.

privacyLevel:GuildScheduledEventPrivacyLevel

The privacy level of the guild scheduled event

Readonly

scheduledEndAt:Date | null

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

scheduledEndTimestamp:number | null

The timestamp the guild scheduled event will end at or null if the event does not have a scheduled time to end

Readonly

scheduledStartAt:Date | null

The time the guild scheduled event will start at This can be potentially null only when it's an

scheduledStartTimestamp:number | null

The timestamp the guild scheduled event will start at

status:S

The status of the guild scheduled event

Readonly

url:string

The URL to the guild scheduled event

userCount:number | null

The number of users who are subscribed to this guild scheduled event

coverImageURL(options?):string | null

The URL of this scheduled event's cover image

Returns

Name	Type	Optional	Description
options	Readonly<BaseImageURLOptions>	Yes	Options for image URL

createInviteURL(options?):Promise<string>

Creates an invite URL to this guild scheduled event.

Name	Type	Optional	Description
options	GuildScheduledEventInviteURLCreateOptions	Yes	The options to create the invite

delete():Promise<GuildScheduledEvent<S>>

Deletes this guild scheduled event.

edit(options):Promise<GuildScheduledEvent<T>>

Edits this guild scheduled event.

Name	Type	Optional	Description
options	GuildScheduledEventEditOptions<S, T>	No	The options to edit the guild scheduled event

fetch(force?):Promise<GuildScheduledEvent<S>>

Fetches this guild scheduled event.

Name	Type	Optional	Description
force	boolean	Yes	Whether to skip the cache check and request the API

fetchSubscribers(options?):Promise<GuildScheduledEventManagerFetchSubscribersResult<T>>

Fetches subscribers of this guild scheduled event.

Name	Type	Optional	Description
options	T	Yes	Options for fetching the subscribers

isActive():this is GuildScheduledEvent<GuildScheduledEventStatus.Active>

Indicates whether this guild scheduled event has an status.

isCanceled():this is GuildScheduledEvent<GuildScheduledEventStatus.Canceled>

Indicates whether this guild scheduled event has a status.

isCompleted():this is GuildScheduledEvent<GuildScheduledEventStatus.Completed>

Indicates whether this guild scheduled event has a status.

isScheduled():this is GuildScheduledEvent<GuildScheduledEventStatus.Scheduled>

Indicates whether this guild scheduled event has a status.

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

Sets the new description of the guild scheduled event.

Name	Type	Optional	Description
description	string	No	The description of the guild scheduled event
reason	string	Yes	The reason for changing the description

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

Sets the new location of the guild scheduled event.

Name	Type	Optional	Description
location	string	No	The location of the guild scheduled event
reason	string	Yes	The reason for changing the location

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

Sets a new name for the guild scheduled event.

Name	Type	Optional	Description
name	string	No	The new name of the guild scheduled event
reason	string	Yes	The reason for changing the name

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

Sets a new time to end the event at.

Name	Type	Optional	Description
scheduledEndTime	DateResolvable	No	The time to end the event at
reason	string	Yes	The reason for changing the scheduled end time

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

Sets a new time to schedule the event at.

Name	Type	Optional	Description
scheduledStartTime	DateResolvable	No	The time to schedule the event at
reason	string	Yes	The reason for changing the scheduled start time

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

Sets the new status of the guild scheduled event. If you're working with TypeScript, use this method in conjunction with status type-guards like isScheduled to get only valid status as suggestion

Name	Type	Optional	Description
status	T	No	The status of the guild scheduled event
reason	string	Yes	The reason for changing the status

toJSON(...props):unknown

Name	Type	Optional	Description
...props	Record<string, boolean \| string>[]	No	None

Inherited from Base

toString():string

When concatenated with a string, this automatically concatenates the event's URL instead of the object.

valueOf():string