Interface INewEvent

Represents a new event.

Index

Properties

Properties

optional public availability?: string

The user's availability status for the event. Valid values are:

  • free
  • busy
  • tentative
  • out_of_office
default

"free"

public description: string

A description of the event, with a maximum length of 32,768 characters. This structure is required.

optional public end_time?: any

The end time of the event. If no end time is specified, the default value is 30 minutes after start_time. This structure is optional when creating an event. When the event is being read, the time will be the user's local time, in ISO 8601 format. Can be a date string, or a Date object.

optional public is_all_day_event?: boolean

A value that specifies whether the event is an all-day event. If the event is an all-day event, this value is true; otherwise, it is false. If this structure is missing, the default value is false.

optional public location?: string

The name of the location at which the event will take place. The maximum length is 1,000 characters.

public name: string

The name of the event, with a maximum length of 255 characters. This structure is required.

optional public reminder_time?: number

The time, in minutes, before the event for the reminder alarm.

public start_time: any

The start time of the event. When the event is being read, the time will be the user's local time, in ISO 8601 format. Can be a date string, or a Date object.

optional public visibility?: string

A value that specifies whether the event is publicly visible. Valid values are:

  • public�the event is visible to anyone who can view the calendar.
  • private"�the event is visible only to the event owner.
default

"public"