nylas/com.nylas.models/CreateEventRequest

CreateEventRequest

Class representing a request to create an event.

Constructors

public CreateEventRequest CreateEventRequest(@Json(name = "when") CreateEventRequest.When whenObj, @Json(name = "title") String title, @Json(name = "description") String description, @Json(name = "location") String location, @Json(name = "participants") List<CreateEventRequest.Participant> participants, @Json(name = "busy") Boolean busy, @Json(name = "conferencing") CreateEventRequest.Conferencing conferencing, @Json(name = "reminders") Reminders reminders, @Json(name = "metadata") Map<String, String> metadata, @Json(name = "recurrence") List<String> recurrence, @Json(name = "calendar_id") String calendarId, @Json(name = "read_only") Boolean readOnly, @Json(name = "visibility") EventVisibility visibility, @Json(name = "capacity") Integer capacity, @Json(name = "hide_participant") Boolean hideParticipant)

Types

Builder

public final class Builder

Builder for CreateEventRequest.

Conferencing

public class Conferencing

This sealed class represents the different types of conferencing configurations.

Participant

public final class Participant

Class representation of an event participant.

When

public class When

This sealed class represents the different types of event time configurations.

Properties

busy

private final Boolean busy

This value determines whether to show this event's time block as available on shared or public calendars.

calendarId

private final String calendarId

Calendar ID of the event.

capacity

private final Integer capacity

Sets the maximum number of participants that may attend the event.

conferencing

private final CreateEventRequest.Conferencing conferencing

Representation of conferencing details for events. Conferencing object can be in one of two formats (sub-objects):

description

private final String description

Creates an event with the specified description. This value may contain more details about an event or an agenda.

hideParticipant

private final Boolean hideParticipant

Whether participants of the event should be hidden.

location

private final String location

Creates an event with the specified location.

metadata

private final Map<String, String> metadata

A list of key-value pairs storing additional data.

participants

private final List<CreateEventRequest.Participant> participants

Creates an event with the specified participants.

readOnly

private final Boolean readOnly

If the event participants are able to edit the event.

recurrence

private final List<String> recurrence

An array of RRULE and EXDATE strings. Please note that EXRULE, RDATE, and TZID are not supported.

reminders

private final Reminders reminders

A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.

title

private final String title

Creates an event with the specified title.

visibility

private final EventVisibility visibility

Sets the visibility for the event. The calendar default will be used if this field is omitted.

whenObj

private final CreateEventRequest.When whenObj

Representation of time and duration for events. When object can be in one of four formats (sub-objects):

Functions

getBusy

public final Boolean getBusy()

This value determines whether to show this event's time block as available on shared or public calendars.

getCalendarId

public final String getCalendarId()

Calendar ID of the event.

getCapacity

public final Integer getCapacity()

Sets the maximum number of participants that may attend the event.

getConferencing

public final CreateEventRequest.Conferencing getConferencing()

Representation of conferencing details for events. Conferencing object can be in one of two formats (sub-objects):

getDescription

public final String getDescription()

Creates an event with the specified description. This value may contain more details about an event or an agenda.

getHideParticipant

public final Boolean getHideParticipant()

Whether participants of the event should be hidden.

getLocation

public final String getLocation()

Creates an event with the specified location.

getMetadata

public final Map<String, String> getMetadata()

A list of key-value pairs storing additional data.

getParticipants

public final List<CreateEventRequest.Participant> getParticipants()

Creates an event with the specified participants.

getReadOnly

public final Boolean getReadOnly()

If the event participants are able to edit the event.

getRecurrence

public final List<String> getRecurrence()

An array of RRULE and EXDATE strings. Please note that EXRULE, RDATE, and TZID are not supported.

getReminders

public final Reminders getReminders()

A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.

getTitle

public final String getTitle()

Creates an event with the specified title.

getVisibility

public final EventVisibility getVisibility()

Sets the visibility for the event. The calendar default will be used if this field is omitted.

getWhenObj

public final CreateEventRequest.When getWhenObj()

Representation of time and duration for events. When object can be in one of four formats (sub-objects):