Google Apps Script API
Preparing search index...
google-apps-script-events
GoogleAppsScript
Calendar
Calendar
Interface Calendar
Represents a calendar that the user owns or is subscribed to.
interface
Calendar
{
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
;
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
;
deleteCalendar
()
:
void
;
getColor
()
:
string
;
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
;
getTimeZone
()
:
string
;
isHidden
()
:
boolean
;
isMyPrimaryCalendar
()
:
boolean
;
isOwnedByMe
()
:
boolean
;
isSelected
()
:
boolean
;
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
;
unsubscribeFromCalendar
()
:
void
;
}
Index
Methods
create
All
Day
Event
create
All
Day
Event
Series
create
Event
create
Event
From
Description
create
Event
Series
delete
Calendar
get
Color
get
Description
get
Event
By
Id
get
Events
get
Event
Series
By
Id
get
Events
For
Day
get
Id
get
Name
get
Time
Zone
is
Hidden
is
My
Primary
Calendar
is
Owned
By
Me
is
Selected
set
Color
set
Description
set
Hidden
set
Name
set
Selected
set
Time
Zone
unsubscribe
From
Calendar
Methods
create
All
Day
Event
createAllDayEvent
(
title
:
string
,
date
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEvent
Parameters
title
:
string
date
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEvent
createAllDayEvent
(
title
:
string
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
endDate
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEvent
Parameters
title
:
string
startDate
:
GoogleAppsScript
.
Base
.
Date
endDate
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEvent
createAllDayEvent
(
title
:
string
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
endDate
:
GoogleAppsScript
.
Base
.
Date
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEvent
Parameters
title
:
string
startDate
:
GoogleAppsScript
.
Base
.
Date
endDate
:
GoogleAppsScript
.
Base
.
Date
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEvent
createAllDayEvent
(
title
:
string
,
date
:
GoogleAppsScript
.
Base
.
Date
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEvent
Parameters
title
:
string
date
:
GoogleAppsScript
.
Base
.
Date
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEvent
create
All
Day
Event
Series
createAllDayEventSeries
(
title
:
string
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
recurrence
:
EventRecurrence
,
)
:
CalendarEventSeries
Parameters
title
:
string
startDate
:
GoogleAppsScript
.
Base
.
Date
recurrence
:
EventRecurrence
Returns
CalendarEventSeries
createAllDayEventSeries
(
title
:
string
,
startDate
:
GoogleAppsScript
.
Base
.
Date
,
recurrence
:
EventRecurrence
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEventSeries
Parameters
title
:
string
startDate
:
GoogleAppsScript
.
Base
.
Date
recurrence
:
EventRecurrence
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEventSeries
create
Event
createEvent
(
title
:
string
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEvent
Parameters
title
:
string
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEvent
createEvent
(
title
:
string
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEvent
Parameters
title
:
string
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEvent
create
Event
From
Description
createEventFromDescription
(
description
:
string
)
:
CalendarEvent
Parameters
description
:
string
Returns
CalendarEvent
create
Event
Series
createEventSeries
(
title
:
string
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
recurrence
:
EventRecurrence
,
)
:
CalendarEventSeries
Parameters
title
:
string
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
recurrence
:
EventRecurrence
Returns
CalendarEventSeries
createEventSeries
(
title
:
string
,
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
recurrence
:
EventRecurrence
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEventSeries
Parameters
title
:
string
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
recurrence
:
EventRecurrence
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEventSeries
delete
Calendar
deleteCalendar
()
:
void
Returns
void
get
Color
getColor
()
:
string
Returns
string
get
Description
getDescription
()
:
string
Returns
string
get
Event
By
Id
getEventById
(
iCalId
:
string
)
:
CalendarEvent
Parameters
iCalId
:
string
Returns
CalendarEvent
get
Events
getEvents
(
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
)
:
CalendarEvent
[]
Parameters
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEvent
[]
getEvents
(
startTime
:
GoogleAppsScript
.
Base
.
Date
,
endTime
:
GoogleAppsScript
.
Base
.
Date
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEvent
[]
Parameters
startTime
:
GoogleAppsScript
.
Base
.
Date
endTime
:
GoogleAppsScript
.
Base
.
Date
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEvent
[]
get
Event
Series
By
Id
getEventSeriesById
(
iCalId
:
string
)
:
CalendarEventSeries
Parameters
iCalId
:
string
Returns
CalendarEventSeries
get
Events
For
Day
getEventsForDay
(
date
:
GoogleAppsScript
.
Base
.
Date
)
:
CalendarEvent
[]
Parameters
date
:
GoogleAppsScript
.
Base
.
Date
Returns
CalendarEvent
[]
getEventsForDay
(
date
:
GoogleAppsScript
.
Base
.
Date
,
options
:
{
[
key
:
string
]:
any
}
,
)
:
CalendarEvent
[]
Parameters
date
:
GoogleAppsScript
.
Base
.
Date
options
:
{
[
key
:
string
]:
any
}
Returns
CalendarEvent
[]
get
Id
getId
()
:
string
Returns
string
get
Name
getName
()
:
string
Returns
string
get
Time
Zone
getTimeZone
()
:
string
Returns
string
is
Hidden
isHidden
()
:
boolean
Returns
boolean
is
My
Primary
Calendar
isMyPrimaryCalendar
()
:
boolean
Returns
boolean
is
Owned
By
Me
isOwnedByMe
()
:
boolean
Returns
boolean
is
Selected
isSelected
()
:
boolean
Returns
boolean
set
Color
setColor
(
color
:
string
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
color
:
string
Returns
GoogleAppsScript
.
Calendar
.
Calendar
set
Description
setDescription
(
description
:
string
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
description
:
string
Returns
GoogleAppsScript
.
Calendar
.
Calendar
set
Hidden
setHidden
(
hidden
:
boolean
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
hidden
:
boolean
Returns
GoogleAppsScript
.
Calendar
.
Calendar
set
Name
setName
(
name
:
string
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
name
:
string
Returns
GoogleAppsScript
.
Calendar
.
Calendar
set
Selected
setSelected
(
selected
:
boolean
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
selected
:
boolean
Returns
GoogleAppsScript
.
Calendar
.
Calendar
set
Time
Zone
setTimeZone
(
timeZone
:
string
)
:
GoogleAppsScript
.
Calendar
.
Calendar
Parameters
timeZone
:
string
Returns
GoogleAppsScript
.
Calendar
.
Calendar
unsubscribe
From
Calendar
unsubscribeFromCalendar
()
:
void
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
create
All
Day
Event
create
All
Day
Event
Series
create
Event
create
Event
From
Description
create
Event
Series
delete
Calendar
get
Color
get
Description
get
Event
By
Id
get
Events
get
Event
Series
By
Id
get
Events
For
Day
get
Id
get
Name
get
Time
Zone
is
Hidden
is
My
Primary
Calendar
is
Owned
By
Me
is
Selected
set
Color
set
Description
set
Hidden
set
Name
set
Selected
set
Time
Zone
unsubscribe
From
Calendar
Google Apps Script API
Loading...
Represents a calendar that the user owns or is subscribed to.