ScheduledEvent class
A scheduled event in a Guild.
- Inheritance
Properties
- channel → PartialChannel?
-
The channel this event will be hosted in.
no setter
- channelId → Snowflake?
-
The ID of the channel this event will be hosted in.
final
- coverImage → CdnAsset?
-
This scheduled event's cover image.
no setter
- coverImageHash → String?
-
The hash of this event's cover image.
final
- creator → User?
-
The user that created this event.
final
- creatorId → Snowflake?
-
The ID of the user that created the event,
final
- creatorMember → PartialMember?
-
The member for the user that created this event.
no setter
- description → String?
-
The description of this event.
final
- entityId → Snowflake?
-
The ID of the entity associated with this event.
final
- guild → PartialGuild
-
The guild this event is in.
no setter
- guildId → Snowflake
-
The ID of the guild this event is in.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → Snowflake
-
The id of this entity.
finalinherited
- manager → ScheduledEventManager
-
The manager for this entity.
finalinherited
- metadata → EntityMetadata?
-
Additional metadata about this event.
final
- name → String
-
The name of this event.
final
- privacyLevel → PrivacyLevel
-
The privacy level of this event.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scheduledEndTime → DateTime?
-
The time at which this event is scheduled to end.
final
- scheduledStartTime → DateTime
-
The time at which this event is scheduled to start.
final
- status → EventStatus
-
The status of this event.
final
- type → ScheduledEntityType
-
The type of the entity associated with this event.
final
- userCount → int?
-
The number of users interested in this event.
final
Methods
-
defaultToString(
) → String -
Same as toString, but only called when dart:mirrors is not available.
inherited
-
delete(
) → Future< void> -
Delete this entity.
inherited
-
fetch(
) → Future< ScheduledEvent> -
Fetch this entity from the API.
inherited
-
get(
) → Future< ScheduledEvent> -
If this entity exists in the manager's cache, return the cached instance. Otherwise, fetch
this entity and return it.
inherited
-
listUsers(
{int? limit, bool? withMembers, Snowflake? before, Snowflake? after}) → Future< List< ScheduledEventUser> > -
List the users that have followed this event.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
covariant UpdateBuilder< ScheduledEvent> builder) → Future<ScheduledEvent> -
Update this entity using the provided builder and return the updated entity.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited