Skip to content

Reference

phil/calendar-sync

Every public type of the package, with its role.

TypeRole
CalendarSyncReads the busy times of a connection into the store; writes and removes events, through the connection's adapter
BusyPeriodA time when someone is taken: a start and an end in UTC, tentative or not
BusyPeriodsBusy periods cut to a window, sorted and joined; at most MAX
SyncWindowThe period read, in UTC, at most MAX_DAYS days
CalendarConnectionA linked calendar: its identifier, its adapter, its calendar and its zone
CredentialsA bearer token, a user name and a password, or nothing; never serialised
OutboundEventAn event the site writes into a calendar
Contract\BusySourceAn adapter that reads busy periods
Contract\CalendarDestinationAn adapter that writes and removes events
Contract\ConnectionRepositoryThe application's connections
Contract\CredentialStoreThe application's credentials, for one call
Contract\BusyStoreWhere the application keeps the busy periods read
Contract\OutboundEventsThe application's events, for the handler of SyncEvent
Adapter\IcsFeedThe adapter ics: a published iCalendar feed, read only
Adapter\CalDavThe adapter caldav: a CalDAV collection
Adapter\GoogleCalendarThe adapter google: Google Calendar API v3
Adapter\MicrosoftGraphThe adapter microsoft: Microsoft Graph v1.0
ICalendar\ICalendarReaderThe busy periods of an iCalendar text within a window
ICalendar\ICalendarWriterAn event as the iCalendar object a CalDAV server stores
Message\RefreshBusyTimesAsks for the busy times of a connection, by identifier and window
Message\RefreshBusyTimesHandlerHandles RefreshBusyTimes
Message\SyncEventAsks for an event to be written or removed, by identifiers
Message\SyncEventHandlerHandles SyncEvent
Exception\CalendarSyncExceptionWhat the package throws
Exception\InvalidSyncA value refused
Exception\InvalidCalendarDataAn answer or a calendar that cannot be read, or is too large
Exception\ProviderFailedA service that refused, failed or did not answer; its adapter and its status
Exception\UnknownConnectionA connection, or an adapter, that is not there

Adapter\HttpCall, Adapter\Json, ICalendar\Components, ICalendar\EventTimes and ICalendar\Periods are internal.