发送反馈
Calendar Service
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
日历
此服务允许脚本访问和修改用户的 Google 日历、
包括用户订阅的其他日历。
类
方法
方法 返回类型 简介
createAllDayEvent(title, date)
CalendarEvent
创建新的全天活动。
createAllDayEvent(title, startDate, endDate)
CalendarEvent
新建可以持续数天的全天活动。
createAllDayEvent(title, startDate, endDate, options)
CalendarEvent
新建可以持续数天的全天活动。
createAllDayEvent(title, date, options)
CalendarEvent
创建新的全天活动。
createAllDayEventSeries(title, startDate, recurrence)
CalendarEventSeries
创建新的全天活动系列。
createAllDayEventSeries(title, startDate, recurrence, options)
CalendarEventSeries
创建新的全天活动系列。
createEvent(title, startTime, endTime)
CalendarEvent
创建新事件。
createEvent(title, startTime, endTime, options)
CalendarEvent
创建新事件。
createEventFromDescription(description)
CalendarEvent
根据自由形式的说明创建事件。
createEventSeries(title, startTime, endTime, recurrence)
CalendarEventSeries
创建新的系列活动。
createEventSeries(title, startTime, endTime, recurrence, options)
CalendarEventSeries
创建新的系列活动。
deleteCalendar()
void
永久删除日历。
getColor()
String
获取日历的颜色。
getDescription()
String
获取日历的说明。
getEventById(iCalId)
CalendarEvent
获取具有指定 ID 的事件。
getEventSeriesById(iCalId)
CalendarEventSeries
获取具有指定 ID 的活动系列。
getEvents(startTime, endTime)
CalendarEvent[]
获取指定时间范围内发生的所有事件。
getEvents(startTime, endTime, options)
CalendarEvent[]
获取给定时间范围内发生且符合指定条件的所有事件。
getEventsForDay(date)
CalendarEvent[]
获取指定日期发生的所有事件。
getEventsForDay(date, options)
CalendarEvent[]
获取指定日期发生且符合指定条件的所有事件。
getId()
String
获取日历 ID。
getName()
String
获取日历名称。
getTimeZone()
String
获取日历的时区。
isHidden()
Boolean
确定日历是否隐藏在界面中。
isMyPrimaryCalendar()
Boolean
确定日历是否为有效用户的主日历。
isOwnedByMe()
Boolean
确定日历是否归您所有。
isSelected()
Boolean
确定日历的活动是否显示在界面中。
setColor(color)
Calendar
设置日历的颜色。
setDescription(description)
Calendar
设置日历说明。
setHidden(hidden)
Calendar
设置日历是否在界面中可见。
setName(name)
Calendar
设置日历名称。
setSelected(selected)
Calendar
设置日历的活动是否在界面中显示。
setTimeZone(timeZone)
Calendar
设置日历的时区。
unsubscribeFromCalendar()
void
为用户退订日历。
方法
方法 返回类型 简介
createAllDayEvent(title, date)
CalendarEvent
创建新的全天活动。
createAllDayEvent(title, startDate, endDate)
CalendarEvent
新建可以持续数天的全天活动。
createAllDayEvent(title, startDate, endDate, options)
CalendarEvent
新建可以持续数天的全天活动。
createAllDayEvent(title, date, options)
CalendarEvent
创建新的全天活动。
createAllDayEventSeries(title, startDate, recurrence)
CalendarEventSeries
创建新的全天活动系列。
createAllDayEventSeries(title, startDate, recurrence, options)
CalendarEventSeries
创建新的全天活动系列。
createCalendar(name)
Calendar
创建归用户所有的新日历。
createCalendar(name, options)
Calendar
创建归用户所有的新日历。
createEvent(title, startTime, endTime)
CalendarEvent
创建新事件。
createEvent(title, startTime, endTime, options)
CalendarEvent
创建新事件。
createEventFromDescription(description)
CalendarEvent
根据自由形式的说明创建事件。
createEventSeries(title, startTime, endTime, recurrence)
CalendarEventSeries
创建新的系列活动。
createEventSeries(title, startTime, endTime, recurrence, options)
CalendarEventSeries
创建新的系列活动。
getAllCalendars()
Calendar[]
获取用户拥有或订阅的所有日历。
getAllOwnedCalendars()
Calendar[]
获取用户拥有的所有日历。
getCalendarById(id)
Calendar
获取具有指定 ID 的日历。
getCalendarsByName(name)
Calendar[]
获取具有用户拥有或订阅的给定名称的所有日历。
getColor()
String
获取日历的颜色。
getDefaultCalendar()
Calendar
获取用户的默认日历。
getDescription()
String
获取日历的说明。
getEventById(iCalId)
CalendarEvent
获取具有指定 ID 的事件。
getEventSeriesById(iCalId)
CalendarEventSeries
获取具有指定 ID 的活动系列。
getEvents(startTime, endTime)
CalendarEvent[]
获取指定时间范围内发生的所有事件。
getEvents(startTime, endTime, options)
CalendarEvent[]
获取给定时间范围内发生且符合指定条件的所有事件。
getEventsForDay(date)
CalendarEvent[]
获取指定日期发生的所有事件。
getEventsForDay(date, options)
CalendarEvent[]
获取指定日期发生且符合指定条件的所有事件。
getId()
String
获取日历 ID。
getName()
String
获取日历名称。
getOwnedCalendarById(id)
Calendar
获取具有指定 ID 的日历(如果用户拥有该日历)。
getOwnedCalendarsByName(name)
Calendar[]
获取用户拥有的具有给定名称的所有日历。
getTimeZone()
String
获取日历的时区。
isHidden()
Boolean
确定日历是否隐藏在界面中。
isMyPrimaryCalendar()
Boolean
确定日历是否为有效用户的主日历。
isOwnedByMe()
Boolean
确定日历是否归您所有。
isSelected()
Boolean
确定日历的活动是否显示在界面中。
newRecurrence()
EventRecurrence
创建一个新的重复周期对象,该对象可用于创建事件重复规则。
setColor(color)
Calendar
设置日历的颜色。
setDescription(description)
Calendar
设置日历说明。
setHidden(hidden)
Calendar
设置日历是否在界面中可见。
setName(name)
Calendar
设置日历名称。
setSelected(selected)
Calendar
设置日历的活动是否在界面中显示。
setTimeZone(timeZone)
Calendar
设置日历的时区。
subscribeToCalendar(id)
Calendar
通过指定 ID 为用户订阅日历(如果允许用户订阅)。
subscribeToCalendar(id, options)
Calendar
通过指定 ID 为用户订阅日历(如果允许用户订阅)。
属性
属性 类型 说明
BLUE
Enum
蓝色 (#2952A3
)。
BROWN
Enum
棕色 (#8D6F47
)。
CHARCOAL
Enum
木炭黑 (#4E5D6C
)。
CHESTNUT
Enum
栗子 (#865A5A
)。
GRAY
Enum
灰色 (#5A6986
)。
GREEN
Enum
绿色 (#0D7813
)。
INDIGO
Enum
靛蓝色 (#5229A3
)。
LIME
Enum
Lime (#528800
)。
MUSTARD
Enum
芥末 (#88880E
)。
OLIVE
Enum
橄榄绿 (#6E6E41
)。
ORANGE
Enum
橙色 (#BE6D00
)。
PINK
Enum
粉色 (#B1365F
)。
PLUM
Enum
紫红色 (#705770
)。
PURPLE
Enum
紫色 (#7A367A
)。
RED
Enum
红色 (#A32929
)。
RED_ORANGE
Enum
橙红色 (#B1440E
)。
SEA_BLUE
Enum
海蓝色 (#29527A
)。
SLATE
Enum
可选广告 (#4A716C
)。
TEAL
Enum
蓝绿色 (#28754E
)。
TURQOISE
Enum
青绿色 (#1B887A
)。
YELLOW
Enum
黄色 (#AB8B00
)。
属性
属性 类型 说明
PALE_BLUE
Enum
浅蓝色 ("1"
)。
PALE_GREEN
Enum
浅绿色 ("2"
)。
MAUVE
Enum
淡紫色 ("3"
)。
PALE_RED
Enum
浅红色 ("4"
)。
YELLOW
Enum
黄色 ("5"
)。
ORANGE
Enum
橙色 ("6"
)。
CYAN
Enum
青色 ("7"
)。
GRAY
Enum
灰色 ("8"
)。
BLUE
Enum
蓝色 ("9"
)。
GREEN
Enum
绿色 ("10"
)。
RED
Enum
红色 ("11"
)。
属性
属性 类型 说明
DEFAULT
Enum
此活动为常规活动。
BIRTHDAY
Enum
本活动是全天的特殊活动,每年重复一次。
FOCUS_TIME
Enum
此活动是专注时间活动。
FROM_GMAIL
Enum
该活动是来自 Gmail 的活动。
OUT_OF_OFFICE
Enum
此活动是“不在办公室”活动。
WORKING_LOCATION
Enum
此活动是工作地点活动。
属性
属性 类型 说明
INVITED
Enum
嘉宾已受到邀请,但尚未表明他们是否参加。
MAYBE
Enum
邀请对象表示他们可能会参加。
NO
Enum
邀请对象表示不参加。
OWNER
Enum
邀请对象是活动的所有者。
YES
Enum
嘉宾已表示会参加。
属性
属性 类型 说明
CONFIDENTIAL
Enum
此活动是不公开的。
DEFAULT
Enum
使用日历上活动的默认公开范围。
PRIVATE
Enum
此活动是私人活动,只有活动参加者才能查看活动详细信息。
PUBLIC
Enum
此活动是公开的,日历的所有读者都可以看到活动详细信息。
发送反馈
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可 获得了许可,并且代码示例已根据 Apache 2.0 许可 获得了许可。有关详情,请参阅 Google 开发者网站政策 。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-07-24。
需要向我们提供更多信息?
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2024-07-24。"],[[["The Google Apps Script Calendar Service enables interaction with Google Calendars, allowing scripts to create, modify, and delete events and calendars."],["It offers classes like `Calendar`, `CalendarApp`, and `CalendarEvent` with specific methods for managing various calendar aspects."],["Recurring events are handled through `CalendarEventSeries` and `RecurrenceRule`, which provide extensive options for recurrence patterns and exclusions."],["The service utilizes enums like `Color`, `EventColor`, and `Visibility` to define event properties."],["`CalendarEvent` methods allow detailed control over event details, such as reminders, guests, and visibility settings."]]],[]]