DeleteCalendarEvent¶
从用户的日历中删除一个事件。
当会议出现在用户的多个收件箱中时,每个收件箱对应一条 ListCalendarEvents 条目。删除其中任何一条之前,先询问用户要删除哪个收件箱中的副本,然后传入该副本的 inbox。切勿自行替用户在这些收件箱之间做选择,无论它们看起来如何:测试地址、次要地址或不熟悉的地址仍然是用户自己的收件箱。仅当用户已经指定了收件箱,或者只有一个副本可删除(isReadOnly 为 false)时,才跳过提问;此时删除该副本并说明原因。没有 inbox 时,工具会拒绝执行,列出每个副本,并给出需要询问的问题。删除用户作为组织者的副本会为所有受邀者取消会议。删除用户作为受邀者的副本会将该会议从该收件箱的日历中移除:在 Google 上,这还会拒绝邀请并告知组织者;而在 Outlook 上,组织者不会收到通知,仍会看到邀请处于未答复状态。
删除操作会立即写入日历提供方,并通知与会者,因此删除前务必与用户确认——此操作无法撤销。从 ListCalendarEvents 获取 eventId。
对于重复性事件,scope 控制删除范围:"all"(默认值)删除整个系列,"this_event" 删除一个发生实例,"this_and_following" 从某个发生实例起终止整个系列。这些范围变体需要目标发生实例的 ListCalendarEvents 条目中的 recurrenceId。
参数¶
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
eventId |
string | 是 | 事件的 ID,来自 ListCalendarEvents 或 CreateCalendarEvent。 |
calendarId |
string | 否 | 要删除的副本的 calendarId,来自其 ListCalendarEvents 条目的 copies,适用于从多个日历同步的事件。省略此参数将删除该事件的主副本。 |
inbox |
string | 否 | 要删除的副本的 inbox,来自其 ListCalendarEvents 条目。当会议在用户的多个收件箱中时必填:没有此参数工具会拒绝执行并列出每个副本。它必须是 eventId 所指定副本所在的收件箱。 |
scope |
"all" | "this_event" | "this_and_following" |
否 | 删除会移除多少重复系列内容。 |
recurrenceId |
string | 否 | 目标发生实例的 recurrenceId,来自其 ListCalendarEvents 条目。"this_event" 和 "this_and_following" 需要此参数。 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro