Interface GetAvailabilityRequest

Interface for a Nylas get availability request

Hierarchy

  • GetAvailabilityRequest

Properties

availabilityRules? durationMinutes endTime intervalMinutes? participants roundTo30Minutes? startTime

Properties

Optional availabilityRules

availabilityRules?: AvailabilityRules

The rules to apply when checking availability.

durationMinutes

durationMinutes: number

The total number of minutes the event should last.

endTime

endTime: number

Unix timestamp for the end time to check availability for.

Optional intervalMinutes

intervalMinutes?: number

Nylas checks from the nearest interval of the passed [startTime]. For example, to schedule 30-minute meetings ([durationMinutes]) with 15 minutes between them ([intervalMinutes]). If you have a meeting starting at 9:59, the API returns times starting at 10:00. 10:00-10:30, 10:15-10:45.

participants

participants: AvailabilityParticipant[]

Participant details to check availability for.

Optional roundTo30Minutes

roundTo30Minutes?: boolean

When set to true, the availability time slots will start at 30 minutes past or on the hour. For example, a free slot starting at 16:10 is considered available only from 16:30.

startTime

startTime: number

Unix timestamp for the start time to check availability for.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc