gws-calendar

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

calendar (v3)

calendar (v3)

PREREQUISITE: Read
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run
gws generate-skills
to create it.
bash
gws calendar <resource> <method> [flags]
前置要求: 阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果缺少该文件,请运行
gws generate-skills
来创建它。
bash
gws calendar <resource> <method> [flags]

Helper Commands

辅助命令

CommandDescription
+insert
create a new event
+agenda
Show upcoming events across all calendars
命令描述
+insert
创建新活动
+agenda
显示所有日历中的即将到来的活动

API Resources

API资源

acl

acl

  • delete
    — Deletes an access control rule.
    • get
      — Returns an access control rule.
    • insert
      — Creates an access control rule.
    • list
      — Returns the rules in the access control list for the calendar.
    • patch
      — Updates an access control rule. This method supports patch semantics.
    • update
      — Updates an access control rule.
    • watch
      — Watch for changes to ACL resources.
  • delete
    — 删除一条访问控制规则。
    • get
      — 返回一条访问控制规则。
    • insert
      — 创建一条访问控制规则。
    • list
      — 返回日历访问控制列表中的规则。
    • patch
      — 更新一条访问控制规则。该方法支持patch语义。
    • update
      — 更新一条访问控制规则。
    • watch
      — 监控ACL资源的变更。

calendarList

calendarList

  • delete
    — Removes a calendar from the user's calendar list.
    • get
      — Returns a calendar from the user's calendar list.
    • insert
      — Inserts an existing calendar into the user's calendar list.
    • list
      — Returns the calendars on the user's calendar list.
    • patch
      — Updates an existing calendar on the user's calendar list. This method supports patch semantics.
    • update
      — Updates an existing calendar on the user's calendar list.
    • watch
      — Watch for changes to CalendarList resources.
  • delete
    — 从用户的日历列表中移除一个日历。
    • get
      — 返回用户日历列表中的一个日历。
    • insert
      — 将现有日历插入到用户的日历列表中。
    • list
      — 返回用户日历列表中的所有日历。
    • patch
      — 更新用户日历列表中的现有日历。该方法支持patch语义。
    • update
      — 更新用户日历列表中的现有日历。
    • watch
      — 监控CalendarList资源的变更。

calendars

calendars

  • clear
    — Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
    • delete
      — Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
    • get
      — Returns metadata for a calendar.
    • insert
      — Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar.
Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior.
  • patch
    — Updates metadata for a calendar. This method supports patch semantics.
  • update
    — Updates metadata for a calendar.
  • clear
    — 清空主日历。此操作会删除与账户主日历关联的所有活动。
    • delete
      — 删除一个次要日历。请使用calendars.clear来清空主日历的所有活动。
    • get
      — 返回日历的元数据。
    • insert
      — 创建一个次要日历。 请求的已认证用户将成为新日历的数据所有者。
注意:我们建议以日历的目标数据所有者身份进行认证。您可以使用全域权限委托来允许应用代表特定用户操作。不要使用服务账户进行认证。如果使用服务账户认证,服务账户将成为数据所有者,这可能会导致意外行为。
  • patch
    — 更新日历的元数据。该方法支持patch语义。
  • update
    — 更新日历的元数据。

channels

channels

  • stop
    — Stop watching resources through this channel
  • stop
    — 停止通过此通道监控资源

colors

colors

  • get
    — Returns the color definitions for calendars and events.
  • get
    — 返回日历和活动的颜色定义。

events

events

  • delete
    — Deletes an event.
    • get
      — Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.
    • import
      — Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported. Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.
    • insert
      — Creates an event.
    • instances
      — Returns instances of the specified recurring event.
    • list
      — Returns events on the specified calendar.
    • move
      — Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.
    • patch
      — Updates an event. This method supports patch semantics.
    • quickAdd
      — Creates an event based on a simple text string.
    • update
      — Updates an event.
    • watch
      — Watch for changes to Events resources.
  • delete
    — 删除一个活动。
    • get
      — 根据Google Calendar ID返回一个活动。要使用iCalendar ID检索活动,请调用events.list方法并使用iCalUID参数。
    • import
      — 导入一个活动。此操作用于将现有活动的私有副本添加到日历中。只有eventType为default的活动可以被导入。 已弃用行为:如果导入非默认类型的活动,其类型将被更改为default,并且所有特定于该活动类型的属性将被丢弃。
    • insert
      — 创建一个活动。
    • instances
      — 返回指定 recurring 活动的实例。
    • list
      — 返回指定日历上的活动。
    • move
      — 将活动移动到另一个日历,即更改活动的组织者。请注意,只有默认类型的活动可以被移动;生日、focusTime、来自Gmail、外出和工作地点活动无法被移动。
    • patch
      — 更新一个活动。该方法支持patch语义。
    • quickAdd
      — 根据简单文本字符串创建活动。
    • update
      — 更新一个活动。
    • watch
      — 监控Events资源的变更。

freebusy

freebusy

  • query
    — Returns free/busy information for a set of calendars.
  • query
    — 返回一组日历的空闲/忙碌信息。

settings

settings

  • get
    — Returns a single user setting.
    • list
      — Returns all user settings for the authenticated user.
    • watch
      — Watch for changes to Settings resources.
  • get
    — 返回单个用户设置。
    • list
      — 返回已认证用户的所有用户设置。
    • watch
      — 监控Settings资源的变更。

Discovering Commands

探索命令

Before calling any API method, inspect it:
bash
undefined
在调用任何API方法之前,请先查看其详情:
bash
undefined

Browse resources and methods

浏览资源和方法

gws calendar --help
gws calendar --help

Inspect a method's required params, types, and defaults

查看方法的必填参数、类型和默认值

gws schema calendar.<resource>.<method>

Use `gws schema` output to build your `--params` and `--json` flags.
gws schema calendar.<resource>.<method>

使用`gws schema`的输出来构建您的`--params`和`--json`标志。