Google Apps Script API
    Preparing search index...

    Interface CalendarApp

    Allows a script to read and update the user's Google Calendar. This class provides direct access to the user's default calendar, as well as the ability to retrieve additional calendars that the user owns or is subscribed to.

    interface CalendarApp {
        Color: typeof GoogleAppsScript.Calendar.Color;
        EventColor: typeof EventColor;
        EventTransparency: typeof EventTransparency;
        EventType: typeof GoogleAppsScript.Calendar.EventType;
        GuestStatus: typeof GuestStatus;
        Month: typeof Month;
        Visibility: typeof Visibility;
        Weekday: typeof Weekday;
        createAllDayEvent(
            title: string,
            date: GoogleAppsScript.Base.Date,
        ): CalendarEvent;
        createAllDayEvent(
            title: string,
            startDate: GoogleAppsScript.Base.Date,
            endDate: GoogleAppsScript.Base.Date,
        ): CalendarEvent;
        createAllDayEvent(
            title: string,
            startDate: GoogleAppsScript.Base.Date,
            endDate: GoogleAppsScript.Base.Date,
            options: { [key: string]: any },
        ): CalendarEvent;
        createAllDayEvent(
            title: string,
            date: GoogleAppsScript.Base.Date,
            options: { [key: string]: any },
        ): CalendarEvent;
        createAllDayEventSeries(
            title: string,
            startDate: GoogleAppsScript.Base.Date,
            recurrence: EventRecurrence,
        ): CalendarEventSeries;
        createAllDayEventSeries(
            title: string,
            startDate: GoogleAppsScript.Base.Date,
            recurrence: EventRecurrence,
            options: { [key: string]: any },
        ): CalendarEventSeries;
        createCalendar(name: string): GoogleAppsScript.Calendar.Calendar;
        createCalendar(
            name: string,
            options: { [key: string]: any },
        ): GoogleAppsScript.Calendar.Calendar;
        createEvent(
            title: string,
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
        ): CalendarEvent;
        createEvent(
            title: string,
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
            options: { [key: string]: any },
        ): CalendarEvent;
        createEventFromDescription(description: string): CalendarEvent;
        createEventSeries(
            title: string,
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
            recurrence: EventRecurrence,
        ): CalendarEventSeries;
        createEventSeries(
            title: string,
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
            recurrence: EventRecurrence,
            options: { [key: string]: any },
        ): CalendarEventSeries;
        getAllCalendars(): GoogleAppsScript.Calendar.Calendar[];
        getAllOwnedCalendars(): GoogleAppsScript.Calendar.Calendar[];
        getCalendarById(id: string): GoogleAppsScript.Calendar.Calendar;
        getCalendarsByName(name: string): GoogleAppsScript.Calendar.Calendar[];
        getColor(): string;
        getDefaultCalendar(): GoogleAppsScript.Calendar.Calendar;
        getDescription(): string;
        getEventById(iCalId: string): CalendarEvent;
        getEvents(
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
        ): CalendarEvent[];
        getEvents(
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
            options: { [key: string]: any },
        ): CalendarEvent[];
        getEventSeriesById(iCalId: string): CalendarEventSeries;
        getEventsForDay(date: GoogleAppsScript.Base.Date): CalendarEvent[];
        getEventsForDay(
            date: GoogleAppsScript.Base.Date,
            options: { [key: string]: any },
        ): CalendarEvent[];
        getId(): string;
        getName(): string;
        getOwnedCalendarById(id: string): GoogleAppsScript.Calendar.Calendar;
        getOwnedCalendarsByName(name: string): GoogleAppsScript.Calendar.Calendar[];
        getTimeZone(): string;
        isHidden(): boolean;
        isMyPrimaryCalendar(): boolean;
        isOwnedByMe(): boolean;
        isSelected(): boolean;
        newRecurrence(): EventRecurrence;
        setColor(color: string): GoogleAppsScript.Calendar.Calendar;
        setDescription(description: string): GoogleAppsScript.Calendar.Calendar;
        setHidden(hidden: boolean): GoogleAppsScript.Calendar.Calendar;
        setName(name: string): GoogleAppsScript.Calendar.Calendar;
        setSelected(selected: boolean): GoogleAppsScript.Calendar.Calendar;
        setTimeZone(timeZone: string): GoogleAppsScript.Calendar.Calendar;
        subscribeToCalendar(id: string): GoogleAppsScript.Calendar.Calendar;
        subscribeToCalendar(
            id: string,
            options: { [key: string]: any },
        ): GoogleAppsScript.Calendar.Calendar;
    }
    Index

    Properties

    Color EventColor EventTransparency EventType GuestStatus Month Visibility Weekday

    Methods

    createAllDayEvent createAllDayEventSeries createCalendar createEvent createEventFromDescription createEventSeries getAllCalendars getAllOwnedCalendars getCalendarById getCalendarsByName getColor getDefaultCalendar getDescription getEventById getEvents getEventSeriesById getEventsForDay getId getName getOwnedCalendarById getOwnedCalendarsByName getTimeZone isHidden isMyPrimaryCalendar isOwnedByMe isSelected newRecurrence setColor setDescription setHidden setName setSelected setTimeZone subscribeToCalendar

    Properties
    Color: typeof GoogleAppsScript.Calendar.Color
    EventColor: typeof EventColor
    EventTransparency: typeof EventTransparency
    EventType: typeof GoogleAppsScript.Calendar.EventType
    GuestStatus: typeof GuestStatus
    Month: typeof Month
    Visibility: typeof Visibility
    Weekday: typeof Weekday

    Methods

    Settings
    Member Visibility

    On This Page
    Properties
    Methods