nylas/com.nylas.models/GetAvailabilityRequest

GetAvailabilityRequest

public final class GetAvailabilityRequest

Class representation of a Nylas get availability request

Constructors

public GetAvailabilityRequest GetAvailabilityRequest(@Json(name = "start_time") Integer startTime, @Json(name = "end_time") Integer endTime, @Json(name = "participants") List<AvailabilityParticipant> participants, @Json(name = "duration_minutes") Integer durationMinutes, @Json(name = "interval_minutes") Integer intervalMinutes, @Json(name = "round_to_30_minutes") Boolean roundTo30Minutes, @Json(name = "availability_rules") AvailabilityRules availabilityRules, @Json(name = "round_to") Integer roundTo)

Types

Builder

public final class Builder

A builder for creating a GetAvailabilityRequest.

Properties

availabilityRules

private final AvailabilityRules availabilityRules

The rules to apply when checking availability.

durationMinutes

private final Integer durationMinutes

The total number of minutes the event should last.

endTime

private final Integer endTime

Unix timestamp for the end time to check availability for.

intervalMinutes

private final Integer intervalMinutes

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

private final List<AvailabilityParticipant> participants

Participant details to check availability for.

roundTo

private final Integer roundTo

The number of minutes to round the time slots to. This allows for rounding to any multiple of 5 minutes, up to a maximum of 60 minutes. The default value is set to 15 minutes. When this variable is assigned a value, it overrides the behavior of the roundTo30Minutes flag, if it was set.

roundTo30Minutes

@Deprecated(message = "Use roundTo instead")

private final Boolean ~~roundTo30Minutes~~

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

private final Integer startTime

Unix timestamp for the start time to check availability for.

Functions

getAvailabilityRules

public final AvailabilityRules getAvailabilityRules()

The rules to apply when checking availability.

getDurationMinutes

public final Integer getDurationMinutes()

The total number of minutes the event should last.

getEndTime

public final Integer getEndTime()

Unix timestamp for the end time to check availability for.

getIntervalMinutes

public final Integer getIntervalMinutes()

getParticipants

public final List<AvailabilityParticipant> getParticipants()

Participant details to check availability for.

getRoundTo

public final Integer getRoundTo()

getRoundTo30Minutes

public final Boolean getRoundTo30Minutes()

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.

getStartTime

public final Integer getStartTime()

Unix timestamp for the start time to check availability for.