Class CalendarsConnector`Abstract`

Hierarchy (View Summary)

CalendarsConnector
- GoogleCalendarsConnector
- MicrosoftCalendarsConnector

Index

Constructors

Properties

dynamoDB TABLES token

Methods

batchGetPutHelper configure deleteAppointment getAccessToken getAppointment postAppointment putAppointment syncCalendar updateAppointmentAttendance updateCalendarConfiguration

Constructors

constructor

new CalendarsConnector(dynamoDB: any): CalendarsConnector
Initialise the connector with a dynamoDB instance to use and the prefix for RESPONSE_URI.
Parameters
- dynamoDB: any
Returns CalendarsConnector
- Defined in calendars.connector.ts:21

Properties

`Protected`dynamoDB

dynamoDB: any

`Protected`TABLES

TABLES: any = ...

The dynamoDB tables involved.

`Protected`token

token: string

The access token used to perform API requests.

Methods

`Protected`batchGetPutHelper

batchGetPutHelper(
appointments: Appointment[],
directPut?: boolean,
): Promise<void>
Get/put for each appointment (one by one) to avoid erasing the linked objects; no error checking.
Parameters
- appointments: Appointment[]
- OptionaldirectPut: boolean
Returns Promise<void>
- Defined in calendars.connector.ts:75

`Abstract`configure

configure(calendarId: string, code: string, projectURL: string): Promise<void>
Connect the calendar with its external link.
Parameters
- calendarId: string
- code: string
- projectURL: string
Returns Promise<void>
- Defined in calendars.connector.ts:26

`Abstract`deleteAppointment

deleteAppointment(calendar: Calendar, appointmentId: string): Promise<void>
Delete an appointment from the external calendar.
Parameters
- calendar: Calendar
- appointmentId: string
Returns Promise<void>
- Defined in calendars.connector.ts:61

`Abstract`getAccessToken

getAccessToken(calendar: Calendar, force?: boolean): Promise<string>
Get an access token for the service.
Parameters
- calendar: Calendar
- Optionalforce: boolean
Returns Promise<string>
- Defined in calendars.connector.ts:36

`Abstract`getAppointment

getAppointment(calendar: Calendar, appointmentId: string): Promise<Appointment>
Get an appointment from the external calendar.
Parameters
- calendar: Calendar
- appointmentId: string
Returns Promise<Appointment>
- Defined in calendars.connector.ts:46

`Abstract`postAppointment

postAppointment(
calendar: Calendar,
appointment: Appointment,
): Promise<Appointment>
Add an appointment in the external calendar and return it updated with external information.
Parameters
- calendar: Calendar
- appointment: Appointment
Returns Promise<Appointment>
- Defined in calendars.connector.ts:51

`Abstract`putAppointment

putAppointment(calendar: Calendar, appointment: Appointment): Promise<void>
Edit an appointment in the external calendar.
Parameters
- calendar: Calendar
- appointment: Appointment
Returns Promise<void>
- Defined in calendars.connector.ts:56

`Abstract`syncCalendar

syncCalendar(calendar: Calendar, firstSync?: boolean): Promise<boolean>
Synchronise the given calendar with its linked one.
Parameters
- calendar: Calendar
- OptionalfirstSync: boolean
Returns Promise<boolean>
- Defined in calendars.connector.ts:41

`Abstract`updateAppointmentAttendance

updateAppointmentAttendance(
    calendar: Calendar,
    appointment: Appointment,
    attendance: AppointmentAttendance,
): Promise<void>
Update the attendance status of an appointment.
Parameters
- calendar: Calendar
- appointment: Appointment
- attendance: AppointmentAttendance
Returns Promise<void>
- Defined in calendars.connector.ts:66

`Abstract`updateCalendarConfiguration

updateCalendarConfiguration(calendar: Calendar): Promise<Calendar>
Update the configuration of the calendar with external data.
Parameters
- calendar: Calendar
Returns Promise<Calendar>
- Defined in calendars.connector.ts:31