Class MicrosoftCalendarsConnector

Hierarchy (View Summary)

CalendarsConnector
- MicrosoftCalendarsConnector

Index

Constructors

Properties

Methods

batchGetPutHelper configure convertAppointmentToExternal deleteAppointment deleteOccurrencesOfMasterAppointment getAccessToken getAppointment postAppointment putAppointment syncCalendar updateAppointmentAttendance updateCalendarConfiguration

Constructors

constructor

new MicrosoftCalendarsConnector(dynamoDB: any): MicrosoftCalendarsConnector
Initialise the connector with a dynamoDB instance to use and the prefix for RESPONSE_URI.
Parameters
- dynamoDB: any
Returns MicrosoftCalendarsConnector
Inherited from CalendarsConnector.constructor
- 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>
Inherited from CalendarsConnector.batchGetPutHelper
- Defined in calendars.connector.ts:75

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>
Overrides CalendarsConnector.configure
- Defined in microsoft.calendars.connector.ts:80

`Protected`convertAppointmentToExternal

convertAppointmentToExternal(appointment: Appointment): any
Parameters
- appointment: Appointment
Returns any
- Defined in microsoft.calendars.connector.ts:452

deleteAppointment

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

`Protected`deleteOccurrencesOfMasterAppointment

deleteOccurrencesOfMasterAppointment(
calendar: Calendar,
masterId: string,
): Promise<void>
Delete all the occurences of a master appointment (-> it has a recurrence).
Parameters
- calendar: Calendar
- masterId: string
Returns Promise<void>
- Defined in microsoft.calendars.connector.ts:279

getAccessToken

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

getAppointment

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

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>
Overrides CalendarsConnector.postAppointment
- Defined in microsoft.calendars.connector.ts:326

putAppointment

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

syncCalendar

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

updateAppointmentAttendance

updateAppointmentAttendance(
    calendar: Calendar,
    appointment: Appointment,
    attendance: AppointmentAttendance,
): Promise<void>
Note: Microsoft doesn't allow changing the attendees statuses with the classic patch; it requires a specific request.
Parameters
- calendar: Calendar
- appointment: Appointment
- attendance: AppointmentAttendance
Returns Promise<void>
Overrides CalendarsConnector.updateAppointmentAttendance
- Defined in microsoft.calendars.connector.ts:385

updateCalendarConfiguration

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

Class MicrosoftCalendarsConnector

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MicrosoftCalendarsConnector

Properties

ProtecteddynamoDB

ProtectedTABLES

Protectedtoken

Methods

ProtectedbatchGetPutHelper

Parameters

Returns Promise<void>

configure

Parameters

Returns Promise<void>

ProtectedconvertAppointmentToExternal

Parameters

Returns any

deleteAppointment

Parameters

Returns Promise<void>

ProtecteddeleteOccurrencesOfMasterAppointment

Parameters

Returns Promise<void>

getAccessToken

Parameters

Returns Promise<string>

getAppointment

Parameters

Returns Promise<Appointment>

postAppointment

Parameters

Returns Promise<Appointment>

putAppointment

Parameters

Returns Promise<void>

syncCalendar

Parameters

Returns Promise<boolean>

updateAppointmentAttendance

Parameters

Returns Promise<void>

updateCalendarConfiguration

Parameters

Returns Promise<Calendar>

Settings

On This Page

`Protected`dynamoDB

`Protected`TABLES

`Protected`token

`Protected`batchGetPutHelper

`Protected`convertAppointmentToExternal

`Protected`deleteOccurrencesOfMasterAppointment