Google Apps Script API
    Preparing search index...

    Interface CalendarEvent

    Represents a single calendar event.

    interface CalendarEvent {
        addEmailReminder(minutesBefore: number): CalendarEvent;
        addGuest(email: string): CalendarEvent;
        addPopupReminder(minutesBefore: number): CalendarEvent;
        addSmsReminder(minutesBefore: number): CalendarEvent;
        anyoneCanAddSelf(): boolean;
        deleteEvent(): void;
        deleteTag(key: string): CalendarEvent;
        getAllDayEndDate(): GoogleAppsScript.Base.Date;
        getAllDayStartDate(): GoogleAppsScript.Base.Date;
        getAllTagKeys(): string[];
        getColor(): string;
        getCreators(): string[];
        getDateCreated(): GoogleAppsScript.Base.Date;
        getDescription(): string;
        getEmailReminders(): number[];
        getEndTime(): GoogleAppsScript.Base.Date;
        getEventSeries(): CalendarEventSeries;
        getEventType(): GoogleAppsScript.Calendar.EventType;
        getGuestByEmail(email: string): EventGuest;
        getGuestList(): EventGuest[];
        getGuestList(includeOwner: boolean): EventGuest[];
        getId(): string;
        getLastUpdated(): GoogleAppsScript.Base.Date;
        getLocation(): string;
        getMyStatus(): GuestStatus;
        getOriginalCalendarId(): string;
        getPopupReminders(): number[];
        getSmsReminders(): number[];
        getStartTime(): GoogleAppsScript.Base.Date;
        getTag(key: string): string;
        getTitle(): string;
        getTransparency(): EventTransparency;
        getVisibility(): Visibility;
        guestsCanInviteOthers(): boolean;
        guestsCanModify(): boolean;
        guestsCanSeeGuests(): boolean;
        isAllDayEvent(): boolean;
        isOwnedByMe(): boolean;
        isRecurringEvent(): boolean;
        removeAllReminders(): CalendarEvent;
        removeGuest(email: string): CalendarEvent;
        resetRemindersToDefault(): CalendarEvent;
        setAllDayDate(date: GoogleAppsScript.Base.Date): CalendarEvent;
        setAllDayDates(
            startDate: GoogleAppsScript.Base.Date,
            endDate: GoogleAppsScript.Base.Date,
        ): CalendarEvent;
        setAnyoneCanAddSelf(anyoneCanAddSelf: boolean): CalendarEvent;
        setColor(color: string | EventColor): CalendarEvent;
        setDescription(description: string): CalendarEvent;
        setGuestsCanInviteOthers(guestsCanInviteOthers: boolean): CalendarEvent;
        setGuestsCanModify(guestsCanModify: boolean): CalendarEvent;
        setGuestsCanSeeGuests(guestsCanSeeGuests: boolean): CalendarEvent;
        setLocation(location: string): CalendarEvent;
        setMyStatus(status: GuestStatus): CalendarEvent;
        setTag(key: string, value: string): CalendarEvent;
        setTime(
            startTime: GoogleAppsScript.Base.Date,
            endTime: GoogleAppsScript.Base.Date,
        ): CalendarEvent;
        setTitle(title: string): CalendarEvent;
        setTransparency(transparency: EventTransparency): CalendarEvent;
        setVisibility(visibility: Visibility): CalendarEvent;
    }
    Index

    Methods

    addEmailReminder addGuest addPopupReminder addSmsReminder anyoneCanAddSelf deleteEvent deleteTag getAllDayEndDate getAllDayStartDate getAllTagKeys getColor getCreators getDateCreated getDescription getEmailReminders getEndTime getEventSeries getEventType getGuestByEmail getGuestList getId getLastUpdated getLocation getMyStatus getOriginalCalendarId getPopupReminders getSmsReminders getStartTime getTag getTitle getTransparency getVisibility guestsCanInviteOthers guestsCanModify guestsCanSeeGuests isAllDayEvent isOwnedByMe isRecurringEvent removeAllReminders removeGuest resetRemindersToDefault setAllDayDate setAllDayDates setAnyoneCanAddSelf setColor setDescription setGuestsCanInviteOthers setGuestsCanModify setGuestsCanSeeGuests setLocation setMyStatus setTag setTime setTitle setTransparency setVisibility

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    addEmailReminder addGuest addPopupReminder addSmsReminder anyoneCanAddSelf deleteEvent deleteTag getAllDayEndDate getAllDayStartDate getAllTagKeys getColor getCreators getDateCreated getDescription getEmailReminders getEndTime getEventSeries getEventType getGuestByEmail getGuestList getId getLastUpdated getLocation getMyStatus getOriginalCalendarId getPopupReminders getSmsReminders getStartTime getTag getTitle getTransparency getVisibility guestsCanInviteOthers guestsCanModify guestsCanSeeGuests isAllDayEvent isOwnedByMe isRecurringEvent removeAllReminders removeGuest resetRemindersToDefault setAllDayDate setAllDayDates setAnyoneCanAddSelf setColor setDescription setGuestsCanInviteOthers setGuestsCanModify setGuestsCanSeeGuests setLocation setMyStatus setTag setTime setTitle setTransparency setVisibility