IGuildEvent class abstract

A representation of a scheduled event in a guild.

Implemented types

Constructors

IGuildEvent()

Properties

channel → Cacheable<Snowflake, IVoiceGuildChannel>?
The channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL
no setter
client → INyxx
Reference to INyxx
no setter
createdAt → DateTime
Gets creation timestamp included in Snowflake
no setterinherited
creator → IUser?
The user that created the scheduled event
no setter
creatorId → Cacheable<Snowflake, IUser>?
The id of the user that created the scheduled event
no setter
description → String?
The description of the scheduled event
no setter
endDate → DateTime?
The time the scheduled event will start
no setter
entityId → Snowflake?
The id of an entity associated with a guild scheduled event
no setter
guild → Cacheable<Snowflake, IGuild>
The guild id which the scheduled event belongs to
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → Snowflake
ID of entity as Snowflake
finalinherited
image → String?
The cover image hash.
no setter
metadata → IEntityMetadata?
Additional metadata for the guild scheduled event
no setter
name → String
The name of the scheduled event
no setter
privacyLevel → GuildEventPrivacyLevel
The privacy level of the scheduled event
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startDate → DateTime
The time the scheduled event will start
no setter
status → GuildEventStatus
The status of the scheduled event
no setter
type → GuildEventType
The type of the scheduled event
no setter
userCount → int?
The number of users subscribed to the scheduled event
no setter

Methods

coverUrl({String format = 'webp', int? size}) → String?
Returns URL to the cover, with given format and size.
delete() → Future<void>
Deletes guild event
edit(GuildEventBuilder builder) → Future<GuildEvent>
Allows editing guild event details and transitioning event between states
fetchUsers({int limit = 100, bool withMember = false, Snowflake? before, Snowflake? after}) → Stream<GuildEventUser>
Allows getting users that are taking part in event
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited