Preview environment

class GuildScheduledEventManager

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

Manages API methods for GuildScheduledEvents and stores their cache.

readonly
cache : Collection<Key, 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
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
options: GuildScheduledEventCreateOptions
) : Promise<GuildScheduledEvent>

Creates a new guild scheduled event.

delete(
guildScheduledEvent: GuildScheduledEventResolvable
) : Promise<void>

Deletes a guild scheduled event.

edit<

Status extends GuildScheduledEventStatus

AcceptableStatus extends GuildScheduledEventSetStatusArg<Status>

>(
guildScheduledEvent: GuildScheduledEventResolvable
options: GuildScheduledEventEditOptions<Status, AcceptableStatus>
) : Promise<GuildScheduledEvent<AcceptableStatus>>

Edits a guild scheduled event.

fetch() : Promise<Collection<Snowflake, GuildScheduledEvent>>

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

fetchSubscribers<

Options extends FetchGuildScheduledEventSubscribersOptions

>(
guildScheduledEvent: GuildScheduledEventResolvable
options?: Options
) : Promise<GuildScheduledEventManagerFetchSubscribersResult<Options>>

Fetches subscribers of a guild scheduled event.

resolve(
idOrInstance: Holds
) : Holds

Resolves a data entry to a data Object.

Returns: An instance from this Manager

resolveId(
idOrInstance: Key | Holds
) : Key

Resolves a data entry to an instance id.

valueOf() : Collection<Key, Holds>

Inherited from: DataManager