GuildScheduledEventManager

classe · Source

Manages API methods for GuildScheduledEvents and stores their cache.

Extends: CachedManager

Properties

guild

guild: Guild

The guild this manager belongs to Source

cache

cache: Collection<Snowflake, GuildScheduledEvent>

The cache of this manager Source

_cache

readonly · private

_cache: Collection

The private cache of items for this manager. Source

holds

readonly · private

holds: function

The data structure belonging to this manager. Source

client

readonly

client: Client

The client that instantiated this Manager Source

Methods

create

async

async create(options: GuildScheduledEventCreateOptions): Promise<GuildScheduledEvent>

Creates a new guild scheduled event. Parameters

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

Returns: Promise<GuildScheduledEvent>Source

fetch

async

async fetch(options?: GuildScheduledEventResolvable | FetchGuildScheduledEventOptions | FetchGuildScheduledEventsOptions): Promise<(GuildScheduledEvent|Collection<Snowflake, GuildScheduledEvent>)>

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

Name	Type	Description
options?	GuildScheduledEventResolvable | FetchGuildScheduledEventOptions | FetchGuildScheduledEventsOptions	The id of the guild scheduled event or options

Returns: Promise<(GuildScheduledEvent\|Collection<Snowflake, GuildScheduledEvent>)>Source

edit

async

async edit(guildScheduledEvent: GuildScheduledEventResolvable, options: GuildScheduledEventEditOptions): Promise<GuildScheduledEvent>

Edits a guild scheduled event. Parameters

Name	Type	Description
guildScheduledEvent	GuildScheduledEventResolvable	The guild scheduled event to edit
options	GuildScheduledEventEditOptions	Options to edit the guild scheduled event

Returns: Promise<GuildScheduledEvent>Source

delete

async

async delete(guildScheduledEvent: GuildScheduledEventResolvable): Promise<void>

Deletes a guild scheduled event. Parameters

Name	Type	Description
guildScheduledEvent	GuildScheduledEventResolvable	The guild scheduled event to delete

Returns: Promise<void>Source

fetchSubscribers

async

async fetchSubscribers(guildScheduledEvent: GuildScheduledEventResolvable, options?: FetchGuildScheduledEventSubscribersOptions): Promise<Collection<Snowflake, GuildScheduledEventUser>>

Fetches subscribers of a guild scheduled event. Parameters

Name	Type	Description
guildScheduledEvent	GuildScheduledEventResolvable	The guild scheduled event to fetch subscribers of
options?	FetchGuildScheduledEventSubscribersOptions	Options for fetching the subscribers Default: {}.

Returns: Promise<Collection<Snowflake, GuildScheduledEventUser>>Source

resolve

resolve(idOrInstance: string | Object): Object

Resolves a data entry to a data Object. Parameters

Name	Type	Description
idOrInstance	string | Object	The id or instance of something in this Manager

Returns: Object — An instance from this Manager Source

resolveId

resolveId(idOrInstance: string | Object): Snowflake

Resolves a data entry to an instance id. Parameters

Name	Type	Description
idOrInstance	string | Object	The id or instance of something in this Manager

Returns: SnowflakeSource