Event class
Represents a calendar event.
Constructors
-
Event({required String eventId, required String instanceId, required String calendarId, required String title, String? description, String? location, required DateTime startDate, required DateTime endDate, required bool isAllDay, required EventAvailability availability, required EventStatus status, String? timeZone, required bool isRecurring, RecurrenceRule? recurrenceRule, List<
Attendee> ? attendees, List<Duration> ? reminders, String? url, String? colorHex}) -
Event.fromMap(Map<
String, dynamic> map) -
Creates an Event from a map returned by the platform.
factory
Properties
-
attendees
→ List<
Attendee> ? -
Attendees of this event (read-only).
final
- availability → EventAvailability
-
Availability status of the event.
final
- calendarId → String
-
ID of the calendar this event belongs to.
final
- color → Color?
-
Parsed colorHex as a Flutter Color, or
nullif absent or unparseable.no setter - colorHex → String?
-
Custom per-event color as a hex string in
#RRGGBBformat (read-only).final - description → String?
-
Description of the event.
final
- endDate → DateTime
-
End date and time of the event.
final
- eventId → String
-
Unique system identifier for this event.
For recurring events, all instances share the same eventId.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- instanceId → String
-
Identifies this specific occurrence; pass it to act on one occurrence of a
recurring series.
final
- isAllDay → bool
-
Whether this is an all-day event.
final
- isRecurring → bool
-
Whether this is a recurring event.
True for recurring events, false for one-time events.
final
- location → String?
-
Location of the event.
final
- recurrenceRule → RecurrenceRule?
-
Parsed recurrence rule for this event.
final
-
reminders
→ List<
Duration> ? -
Relative-time reminders for this event, each a lead time before start
(e.g.
Duration(minutes: 15)). Null when there are none.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startDate → DateTime
-
Start date and time of the event.
final
- status → EventStatus
-
Status of the event.
final
- timeZone → String?
-
Timezone identifier for the event (e.g., "America/New_York").
Null for all-day events (floating dates).
final
- title → String
-
Title of the event.
final
- url → String?
-
Optional URL associated with this event — typically a meeting link, ticket
page, or deep link. Visible in the native Calendar UI on iOS; round-trips
through the plugin on Android.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> - Converts this Event to a map for platform communication.
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override