Google Apps Script API
Preparing search index...
google-apps-script-events
GoogleAppsScript
Calendar
CalendarEventSeries
Interface CalendarEventSeries
Represents a series of events (a recurring event).
interface
CalendarEventSeries
{
addEmailReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
;
addGuest
(
email
:
string
)
:
CalendarEventSeries
;
addPopupReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
;
addSmsReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
;
anyoneCanAddSelf
()
:
boolean
;
deleteEventSeries
()
:
void
;
deleteTag
(
key
:
string
)
:
CalendarEventSeries
;
getAllTagKeys
()
:
string
[]
;
getColor
()
:
string
;
getCreators
()
:
string
[]
;
getDateCreated
()
:
GoogleAppsScript
.
Base
.
Date
;
getDescription
()
:
string
;
getEmailReminders
()
:
number
[]
;
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
[]
;
getTag
(
key
:
string
)
:
string
;
getTitle
()
:
string
;
getVisibility
()
:
Visibility
;
guestsCanInviteOthers
()
:
boolean
;
guestsCanModify
()
:
boolean
;
guestsCanSeeGuests
()
:
boolean
;
isOwnedByMe
()
:
boolean
;
removeAllReminders
()
:
CalendarEventSeries
;
removeGuest
(
email
:
string
)
:
CalendarEventSeries
;
resetRemindersToDefault
()
:
CalendarEventSeries
;
setAnyoneCanAddSelf
(
anyoneCanAddSelf
:
boolean
)
:
CalendarEventSeries
;
setColor
(
color
:
string
)
:
CalendarEventSeries
;
setDescription
(
description
:
string
)
:
CalendarEventSeries
;
setGuestsCanInviteOthers
(
guestsCanInviteOthers
:
boolean
,
)
:
CalendarEventSeries
;
setGuestsCanModify
(
guestsCanModify
:
boolean
)
:
CalendarEventSeries
;
setGuestsCanSeeGuests
(
guestsCanSeeGuests
:
boolean
)
:
CalendarEventSeries
;
setLocation
(
location
:
string
)
:
CalendarEventSeries
;
setMyStatus
(
status
:
GuestStatus
)
:
CalendarEventSeries
;
setRecurrence
(
recurrence
:
EventRecurrence
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEventSeries
;
setRecurrence
(
recurrence
:
EventRecurrence
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEventSeries
;
setTag
(
key
:
string
,
value
:
string
)
:
CalendarEventSeries
;
setTitle
(
title
:
string
)
:
CalendarEventSeries
;
setVisibility
(
visibility
:
Visibility
)
:
CalendarEventSeries
;
}
Index
Methods
add
Email
Reminder
add
Guest
add
Popup
Reminder
add
Sms
Reminder
anyone
Can
Add
Self
delete
Event
Series
delete
Tag
get
All
Tag
Keys
get
Color
get
Creators
get
Date
Created
get
Description
get
Email
Reminders
get
Event
Type
get
Guest
By
Email
get
Guest
List
get
Id
get
Last
Updated
get
Location
get
My
Status
get
Original
Calendar
Id
get
Popup
Reminders
get
Sms
Reminders
get
Tag
get
Title
get
Visibility
guests
Can
Invite
Others
guests
Can
Modify
guests
Can
See
Guests
is
Owned
By
Me
remove
All
Reminders
remove
Guest
reset
Reminders
To
Default
set
Anyone
Can
Add
Self
set
Color
set
Description
set
Guests
Can
Invite
Others
set
Guests
Can
Modify
set
Guests
Can
See
Guests
set
Location
set
My
Status
set
Recurrence
set
Tag
set
Title
set
Visibility
Methods
add
Email
Reminder
addEmailReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
Parameters
minutesBefore
:
number
Returns
CalendarEventSeries
add
Guest
addGuest
(
email
:
string
)
:
CalendarEventSeries
Parameters
email
:
string
Returns
CalendarEventSeries
add
Popup
Reminder
addPopupReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
Parameters
minutesBefore
:
number
Returns
CalendarEventSeries
add
Sms
Reminder
addSmsReminder
(
minutesBefore
:
number
)
:
CalendarEventSeries
Parameters
minutesBefore
:
number
Returns
CalendarEventSeries
anyone
Can
Add
Self
anyoneCanAddSelf
()
:
boolean
Returns
boolean
delete
Event
Series
deleteEventSeries
()
:
void
Returns
void
delete
Tag
deleteTag
(
key
:
string
)
:
CalendarEventSeries
Parameters
key
:
string
Returns
CalendarEventSeries
get
All
Tag
Keys
getAllTagKeys
()
:
string
[]
Returns
string
[]
get
Color
getColor
()
:
string
Returns
string
get
Creators
getCreators
()
:
string
[]
Returns
string
[]
get
Date
Created
getDateCreated
()
:
GoogleAppsScript
.
Base
.
Date
Returns
GoogleAppsScript
.
Base
.
Date
get
Description
getDescription
()
:
string
Returns
string
get
Email
Reminders
getEmailReminders
()
:
number
[]
Returns
number
[]
get
Event
Type
getEventType
()
:
GoogleAppsScript
.
Calendar
.
EventType
Returns
GoogleAppsScript
.
Calendar
.
EventType
get
Guest
By
Email
getGuestByEmail
(
email
:
string
)
:
EventGuest
Parameters
email
:
string
Returns
EventGuest
get
Guest
List
getGuestList
()
:
EventGuest
[]
Returns
EventGuest
[]
getGuestList
(
includeOwner
:
boolean
)
:
EventGuest
[]
Parameters
includeOwner
:
boolean
Returns
EventGuest
[]
get
Id
getId
()
:
string
Returns
string
get
Last
Updated
getLastUpdated
()
:
GoogleAppsScript
.
Base
.
Date
Returns
GoogleAppsScript
.
Base
.
Date
get
Location
getLocation
()
:
string
Returns
string
get
My
Status
getMyStatus
()
:
GuestStatus
Returns
GuestStatus
get
Original
Calendar
Id
getOriginalCalendarId
()
:
string
Returns
string
get
Popup
Reminders
getPopupReminders
()
:
number
[]
Returns
number
[]
get
Sms
Reminders
getSmsReminders
()
:
number
[]
Returns
number
[]
get
Tag
getTag
(
key
:
string
)
:
string
Parameters
key
:
string
Returns
string
get
Title
getTitle
()
:
string
Returns
string
get
Visibility
getVisibility
()
:
Visibility
Returns
Visibility
guests
Can
Invite
Others
guestsCanInviteOthers
()
:
boolean
Returns
boolean
guests
Can
Modify
guestsCanModify
()
:
boolean
Returns
boolean
guests
Can
See
Guests
guestsCanSeeGuests
()
:
boolean
Returns
boolean
is
Owned
By
Me
isOwnedByMe
()
:
boolean
Returns
boolean
remove
All
Reminders
removeAllReminders
()
:
CalendarEventSeries
Returns
CalendarEventSeries
remove
Guest
removeGuest
(
email
:
string
)
:
CalendarEventSeries
Parameters
email
:
string
Returns
CalendarEventSeries
reset
Reminders
To
Default
resetRemindersToDefault
()
:
CalendarEventSeries
Returns
CalendarEventSeries
set
Anyone
Can
Add
Self
setAnyoneCanAddSelf
(
anyoneCanAddSelf
:
boolean
)
:
CalendarEventSeries
Parameters
anyoneCanAddSelf
:
boolean
Returns
CalendarEventSeries
set
Color
setColor
(
color
:
string
)
:
CalendarEventSeries
Parameters
color
:
string
Returns
CalendarEventSeries
set
Description
setDescription
(
description
:
string
)
:
CalendarEventSeries
Parameters
description
:
string
Returns
CalendarEventSeries
set
Guests
Can
Invite
Others
setGuestsCanInviteOthers
(
guestsCanInviteOthers
:
boolean
)
:
CalendarEventSeries
Parameters
guestsCanInviteOthers
:
boolean
Returns
CalendarEventSeries
set
Guests
Can
Modify
setGuestsCanModify
(
guestsCanModify
:
boolean
)
:
CalendarEventSeries
Parameters
guestsCanModify
:
boolean
Returns
CalendarEventSeries
set
Guests
Can
See
Guests
setGuestsCanSeeGuests
(
guestsCanSeeGuests
:
boolean
)
:
CalendarEventSeries
Parameters
guestsCanSeeGuests
:
boolean
Returns
CalendarEventSeries
set
Location
setLocation
(
location
:
string
)
:
CalendarEventSeries
Parameters
location
:
string
Returns
CalendarEventSeries
set
My
Status
setMyStatus
(
status
:
GuestStatus
)
:
CalendarEventSeries
Parameters
status
:
GuestStatus
Returns
CalendarEventSeries
set
Recurrence
setRecurrence
(
recurrence
:
EventRecurrence
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEventSeries
Parameters
recurrence
:
EventRecurrence
startDate
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEventSeries
setRecurrence
(
recurrence
:
EventRecurrence
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEventSeries
Parameters
recurrence
:
EventRecurrence
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEventSeries
set
Tag
setTag
(
key
:
string
,
value
:
string
)
:
CalendarEventSeries
Parameters
key
:
string
value
:
string
Returns
CalendarEventSeries
set
Title
setTitle
(
title
:
string
)
:
CalendarEventSeries
Parameters
title
:
string
Returns
CalendarEventSeries
set
Visibility
setVisibility
(
visibility
:
Visibility
)
:
CalendarEventSeries
Parameters
visibility
:
Visibility
Returns
CalendarEventSeries
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Email
Reminder
add
Guest
add
Popup
Reminder
add
Sms
Reminder
anyone
Can
Add
Self
delete
Event
Series
delete
Tag
get
All
Tag
Keys
get
Color
get
Creators
get
Date
Created
get
Description
get
Email
Reminders
get
Event
Type
get
Guest
By
Email
get
Guest
List
get
Id
get
Last
Updated
get
Location
get
My
Status
get
Original
Calendar
Id
get
Popup
Reminders
get
Sms
Reminders
get
Tag
get
Title
get
Visibility
guests
Can
Invite
Others
guests
Can
Modify
guests
Can
See
Guests
is
Owned
By
Me
remove
All
Reminders
remove
Guest
reset
Reminders
To
Default
set
Anyone
Can
Add
Self
set
Color
set
Description
set
Guests
Can
Invite
Others
set
Guests
Can
Modify
set
Guests
Can
See
Guests
set
Location
set
My
Status
set
Recurrence
set
Tag
set
Title
set
Visibility
Google Apps Script API
Loading...
Represents a series of events (a recurring event).