Event

public final class Event

Class representing a Nylas Event object.

Constructors

Link copied to clipboard
public Event Event(@Json(name = "id") String id, @Json(name = "grant_id") String grantId, @Json(name = "when") When whenObj, @Json(name = "busy") Boolean busy, @Json(name = "calendar_id") String calendarId, @Json(name = "hide_participants") Boolean hideParticipants, @Json(name = "object") String obj, @Json(name = "participants") List<Participant> participants, @Json(name = "read_only") Boolean readOnly, @Json(name = "visibility") EventVisibility visibility, @Json(name = "conferencing") Conferencing conferencing, @Json(name = "description") String description, @Json(name = "ical_uid") String icalUid, @Json(name = "location") String location, @Json(name = "metadata") Map<String, String> metadata, @Json(name = "organizer") EmailName organizer, @Json(name = "master_event_id") String masterEventId, @Json(name = "recurrence") List<String> recurrence, @Json(name = "reminders") Reminders reminders, @Json(name = "status") EventStatus status, @Json(name = "title") String title, @Json(name = "creator") EmailName creator, @Json(name = "html_link") String htmlLink, @Json(name = "capacity") Integer capacity, @Json(name = "created_at") Long createdAt, @Json(name = "updated_at") Long updatedAt)

Properties

Link copied to clipboard
private final Boolean busy

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

Link copied to clipboard
private final String calendarId

Calendar ID of the event.

Link copied to clipboard
private final Integer capacity

The maximum number of participants that may attend the event

Link copied to clipboard
private final Conferencing conferencing

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

Link copied to clipboard
private final Long createdAt

Unix timestamp when the event was created.

Link copied to clipboard
private final EmailName creator

User who created the event. Not supported for all providers.

Link copied to clipboard
private final String description

Description of the event.

Link copied to clipboard
private final String grantId

Grant ID of the Nylas account.

Link copied to clipboard
private final Boolean hideParticipants

Whether participants of the event should be hidden.

Link copied to clipboard
private final String htmlLink

A link to this event in the provider's UI

Link copied to clipboard
private final String icalUid

Unique id for iCalendar standard, for identifying events across calendaring systems. Recurring events may share the same value. Can be null for events synced before the year 2020.

Link copied to clipboard
private final String id

Globally unique object identifier.

Link copied to clipboard
private final String location

Location of the event, such as a physical address or meeting room name.

Link copied to clipboard
private final String masterEventId

Organizer of the event.

Link copied to clipboard
private final Map<String, String> metadata

List of key-value pairs storing additional data.

Link copied to clipboard
private final EmailName organizer

Organizer of the event.

Link copied to clipboard
private final List<Participant> participants

List of participants invited to the event. Participants may also be rooms or resources.

Link copied to clipboard
private final Boolean readOnly

If the event participants are able to edit the event.

Link copied to clipboard
private final List<String> recurrence

A list of RRULE and EXDATE strings.

Link copied to clipboard
private final Reminders reminders

List of reminders for the event.

Link copied to clipboard
private final EventStatus status

Status of the event.

Link copied to clipboard
private final String title

Title of the event.

Link copied to clipboard
private final Long updatedAt

Unix timestamp when the event was last updated.

Link copied to clipboard

Visibility of the event, if the event is private or public.

Functions

Link copied to clipboard
public final Boolean getBusy()

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

Link copied to clipboard
public final String getCalendarId()

Calendar ID of the event.

Link copied to clipboard
public final Integer getCapacity()

The maximum number of participants that may attend the event

Link copied to clipboard

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

Link copied to clipboard
public final Long getCreatedAt()

Unix timestamp when the event was created.

Link copied to clipboard
public final EmailName getCreator()

User who created the event. Not supported for all providers.

Link copied to clipboard
public final String getDescription()

Description of the event.

Link copied to clipboard
public final String getGrantId()

Grant ID of the Nylas account.

Link copied to clipboard

Whether participants of the event should be hidden.

Link copied to clipboard
public final String getHtmlLink()

A link to this event in the provider's UI

Link copied to clipboard
public final String getIcalUid()

Unique id for iCalendar standard, for identifying events across calendaring systems. Recurring events may share the same value. Can be null for events synced before the year 2020.

Link copied to clipboard
public final String getId()

Globally unique object identifier.

Link copied to clipboard
public final String getLocation()

Location of the event, such as a physical address or meeting room name.

Link copied to clipboard
public final String getMasterEventId()

Organizer of the event.

Link copied to clipboard
public final Map<String, String> getMetadata()

List of key-value pairs storing additional data.

Link copied to clipboard
public final String getObject()

Get the type of object.

Link copied to clipboard
public final EmailName getOrganizer()

Organizer of the event.

Link copied to clipboard

List of participants invited to the event. Participants may also be rooms or resources.

Link copied to clipboard
public final Boolean getReadOnly()

If the event participants are able to edit the event.

Link copied to clipboard
public final List<String> getRecurrence()

A list of RRULE and EXDATE strings.

Link copied to clipboard
public final Reminders getReminders()

List of reminders for the event.

Link copied to clipboard
public final EventStatus getStatus()

Status of the event.

Link copied to clipboard
public final String getTitle()

Title of the event.

Link copied to clipboard
public final Long getUpdatedAt()

Unix timestamp when the event was last updated.

Link copied to clipboard

Visibility of the event, if the event is private or public.

Link copied to clipboard
public final When getWhen()

Get the representation of time and duration for events.