Skip to content

GuildScheduledEventManager

Defined in: packages/managers/src/guild-resources.ts:131

Manages a guild’s scheduled events, cached by event ID.

new GuildScheduledEventManager(rest, guildId): GuildScheduledEventManager

Defined in: packages/managers/src/guild-resources.ts:138

REST

string

GuildScheduledEventManager

Manager.constructor

readonly cache: Collection<string, APIGuildScheduledEvent>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

Manager.cache


readonly guildId: string

Defined in: packages/managers/src/guild-resources.ts:136

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

Manager.size

[iterator](): IterableIterator<[string, APIGuildScheduledEvent]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, APIGuildScheduledEvent]>

Cache iterator.

Manager.[iterator]


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

Manager.clear


create(options): Promise<APIGuildScheduledEvent>

Defined in: packages/managers/src/guild-resources.ts:176

Creates an event.

GuildScheduledEventOptions

Promise<APIGuildScheduledEvent>


delete(id): boolean

Defined in: packages/managers/src/base.ts:96

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


edit(eventId, options): Promise<APIGuildScheduledEvent>

Defined in: packages/managers/src/guild-resources.ts:190

Edits an event.

string

GuildScheduledEventOptions

Promise<APIGuildScheduledEvent>


fetch(eventId, options?): Promise<APIGuildScheduledEvent>

Defined in: packages/managers/src/guild-resources.ts:150

Fetches one event.

string

boolean

Promise<APIGuildScheduledEvent>


fetchAll(options?): Promise<APIGuildScheduledEvent[]>

Defined in: packages/managers/src/guild-resources.ts:164

Fetches every event in the guild.

boolean

Promise<APIGuildScheduledEvent[]>


fetchSubscribers(eventId, options?): Promise<object[]>

Defined in: packages/managers/src/guild-resources.ts:214

Fetches users subscribed to an event (limit 1-100).

string

string

string

number

boolean

Promise<object[]>


find(predicate): APIGuildScheduledEvent | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

APIGuildScheduledEvent | undefined

Matching value.

Manager.find


first(): APIGuildScheduledEvent | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

APIGuildScheduledEvent | undefined

First value.

Manager.first


get(id): APIGuildScheduledEvent | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

APIGuildScheduledEvent | undefined

Cached value.

Manager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

Manager.has


remove(eventId, reason?): Promise<void>

Defined in: packages/managers/src/guild-resources.ts:205

Deletes an event.

string

string

Audit-log reason.

Promise<void>


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

APIGuildScheduledEvent

Value.

this

This manager.

Manager.set


values(): APIGuildScheduledEvent[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

APIGuildScheduledEvent[]

Array of values.

Manager.values