GuildScheduledEvent class
Guild Scheduled Event structure
See field requirements by entity type to understand the relationship between entityType and the following fields: channelId, entityMetadata, and scheduledEndTime
- Annotations
-
- @JsonSerializable(includeIfNull: false)
Constructors
- GuildScheduledEvent({required String id, required String guildId, String? channelId, String? creatorId, required String name, String? description, required DateTime scheduledStartTime, DateTime? scheduledEndTime, required PrivacyLevel privacyLevel, required GuildScheduledEventStatus status, required GuildScheduledEventEntityType entityType, String? entityId, GuildScheduledEventEntityMetadata? entityMetadata, User? creator, int? userCount})
- Constructor
-
GuildScheduledEvent.fromJson(Map<
String, dynamic> json) -
From json
factory
Properties
- channelId → String?
-
the channel id in which the scheduled event will be hosted, or null if
scheduled entity type is EXTERNAL
final
- creator → User?
-
the user that created the scheduled event
final
- creatorId → String?
-
the id of the user that created the scheduled event
final
- description → String?
-
the description of the scheduled event (1-1000 characters)
final
- entityId → String?
-
the id of an entity associated with a guild scheduled event
final
- entityMetadata → GuildScheduledEventEntityMetadata?
-
additional metadata for the guild scheduled event
final
- entityType → GuildScheduledEventEntityType
-
the type of the scheduled event
final
- guildId → String
-
the guild id which the scheduled event belongs to
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
the id of the scheduled event
final
- name → String
-
the name of the scheduled event (1-100 characters)
final
- privacyLevel → PrivacyLevel
-
the privacy level of the scheduled event
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scheduledEndTime → DateTime?
-
the time the scheduled event will end, required if entity_type is EXTERNAL
final
- scheduledStartTime → DateTime
-
the time the scheduled event will start
final
- status → GuildScheduledEventStatus
-
the status of the scheduled event
final
- userCount → int?
-
the number of users subscribed to the scheduled event
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - To json
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited