Skip to content
CARP Documentation

CalendarEvent

A calendar event, as listed in a Calendar.

Annotations

Constructors

CalendarEvent.fromEvent

CalendarEvent.fromEvent(
  1. Event event
)

Creates a CalendarEvent from an event from the device calendar plugin.

CalendarEvent.fromJson

CalendarEvent.fromJson(
  1. Map<String, dynamic> json
)

CalendarEvent

CalendarEvent([
  1. String? eventId,
  2. String? calendarId,
  3. String? title,
  4. String? description,
  5. DateTime? start,
  6. DateTime? end,
  7. bool? allDay,
  8. String? location,
  9. String? status,
  10. String? timeZone,
  11. bool isRecurring = false,
])

Properties

allDay

bool? allDay
getter/setter pair

Whether this is an all-day event.

calendarId

String? calendarId
getter/setter pair

The identifier of the calendar that this event is associated with.

description

String? description
getter/setter pair

The description for this event.

end

DateTime? end
getter/setter pair

When the event ends (UTC).

eventId

String? eventId
getter/setter pair

The unique identifier for this event.

isRecurring

bool isRecurring
final

Whether this is a recurring event. True for recurring events, false for one-time events.

location

String? location
getter/setter pair

The location of this event.

start

DateTime? start
getter/setter pair

When the event starts (UTC).

status

String? status
final

Status of the event, e.g. confirmed, tentative or canceled.

timeZone

String? timeZone
final

Timezone identifier for the event (e.g., "America/New_York"). Null for all-day events (floating dates).

title

String? title
getter/setter pair

The title of this event.

Methods

toJson

Map<String, dynamic> toJson()