ScheduledEventManager class

A Manager for ScheduledEvents.

Inheritance

• Object
• ReadOnlyManager<ScheduledEvent>
• Manager<ScheduledEvent>
• ScheduledEventManager

Constructors

ScheduledEventManager(CacheConfig<ScheduledEvent> config, NyxxRest client, {required Snowflake guildId})

Create a new ScheduledEventManager.

Properties

cache → Cache<ScheduledEvent>

The cache for this manager.

final, inherited

client → NyxxRest

The client this manager belongs to.

final, inherited

guildId → Snowflake

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create(covariant ScheduledEventBuilder builder, {String? auditLogReason}) → Future<ScheduledEvent>

Create a new instance of the type of this manager.

override

delete(Snowflake id) → Future<void>

Delete the item with the given id from the API.

override

fetch(Snowflake id, {bool? withUserCount}) → Future<ScheduledEvent>

Fetch the item with the given id from the API.

override

get(Snowflake id) → Future<ScheduledEvent>

Get an item by its id from the cache if it exists, else fetch it from the API.

inherited

list({bool? withUserCounts}) → Future<List<ScheduledEvent>>

List the ScheduledEvents in the guild.

listEventUsers(Snowflake id, {int? limit, bool? withMembers, Snowflake? before, Snowflake? after}) → Future<List<ScheduledEventUser>>

List the users that have followed an event.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parse(Map<String, Object?> raw) → ScheduledEvent

Parse the raw data received from the API into an instance of the type of this manager.

override

parseEntityMetadata(Map<String, Object?> raw) → EntityMetadata

parseScheduledEventUser(Map<String, Object?> raw) → ScheduledEventUser

toString() → String

A string representation of this object.

inherited

update(Snowflake id, covariant ScheduledEventUpdateBuilder builder, {String? auditLogReason}) → Future<ScheduledEvent>

Update the item with the given id in the API.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](Snowflake id) → PartialScheduledEvent

Return a partial instance of the entity with ID id containing no data.

override