discord.js | GuildScheduledEventManager

Search...

GuildScheduledEventManager

export class GuildScheduledEventManager extends CachedManager<
  Snowflake,
  GuildScheduledEvent,
  GuildScheduledEventResolvable
>

export class GuildScheduledEventManager extends CachedManager<
  Snowflake,
  GuildScheduledEvent,
  GuildScheduledEventResolvable
>

Manages API methods for GuildScheduledEvents and stores their cache.

Readonly

cache:Collection<K, Holds>

The cache of items for this manager.

Inherited from DataManager

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

guild:Guild

The guild this manager belongs to

Readonly

The data structure belonging to this manager.

Inherited from DataManager

create(options):Promise<GuildScheduledEvent>

Creates a new guild scheduled event.

Name	Type	Optional	Description
options	GuildScheduledEventCreateOptions	No	Options for creating the guild scheduled event

delete(guildScheduledEvent):Promise<void>

Deletes a guild scheduled event.

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEventResolvable	No	The guild scheduled event to delete

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

Edits a guild scheduled event.

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

Obtains one or more guild scheduled events from Discord, or the guild cache if it's already available.

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

Fetches subscribers of a guild scheduled event.

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEventResolvable	No	The guild scheduled event to fetch subscribers of
options	T	Yes	Options for fetching the subscribers

resolve(idOrInstance):Holds

Resolves a data entry to a data Object.

An instance from this Manager

Name	Type	Optional	Description
idOrInstance	Holds	No	The id or instance of something in this Manager

resolveId(idOrInstance):K

Resolves a data entry to an instance id.

Name	Type	Optional	Description
idOrInstance	K \| Holds	No	The id or instance of something in this Manager

valueOf():Collection<K, Holds>