gws-tasks

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

tasks (v1)

tasks (v1)

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

API Resources

API 资源

tasklists

tasklists

  • delete
    — Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.
    • get
      — Returns the authenticated user's specified task list.
    • insert
      — Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.
    • list
      — Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.
    • patch
      — Updates the authenticated user's specified task list. This method supports patch semantics.
    • update
      — Updates the authenticated user's specified task list.
  • delete
    — 删除已认证用户指定的任务列表。如果该列表包含已分配的任务,那么分配的任务以及分配场景(Docs、Chat Spaces)中的原始任务都会被删除。
    • get
      — 返回已认证用户指定的任务列表。
    • insert
      — 创建一个新的任务列表并添加到已认证用户的任务列表中。用户最多可同时拥有2000个任务列表。
    • list
      — 返回已认证用户的所有任务列表。用户最多可同时拥有2000个任务列表。
    • patch
      — 更新已认证用户指定的任务列表。该方法支持patch语义。
    • update
      — 更新已认证用户指定的任务列表。

tasks

tasks

  • clear
    — Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.
    • delete
      — Deletes the specified task from the task list. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there.
    • get
      — Returns the specified task.
    • insert
      — Creates a new task on the specified task list. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.
    • list
      — Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.
    • move
      — Moves the specified task to another position in the destination task list. If the destination list is not specified, the task is moved within its current list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. A user can have up to 2,000 subtasks per task.
    • patch
      — Updates the specified task. This method supports patch semantics.
    • update
      — Updates the specified task.
  • clear
    — 清除指定任务列表中所有已完成的任务。受影响的任务会被标记为“隐藏”,默认情况下,在获取任务列表的所有任务时将不再返回这些任务。
    • delete
      — 从任务列表中删除指定的任务。如果该任务已被分配,那么分配的任务以及分配场景(Docs、Chat Spaces)中的原始任务都会被删除。如果只想删除已分配的任务,请前往分配场景取消任务分配。
    • get
      — 返回指定的任务。
    • insert
      — 在指定的任务列表中创建一个新任务。从Docs或Chat Spaces分配的任务无法通过Tasks公开API插入;只能通过从Docs或Chat Spaces分配来创建。用户每个列表最多可拥有20000个非隐藏任务,总计最多可拥有100000个任务。
    • list
      — 返回指定任务列表中的所有任务。默认不会返回已分配的任务(来自Docs、Chat Spaces)。用户每个列表最多可拥有20000个非隐藏任务,总计最多可拥有100000个任务。
    • move
      — 将指定任务移动到目标任务列表中的其他位置。如果未指定目标列表,则任务会在当前列表内移动。这可以包括将其作为子任务放到新的父任务下,以及/或者在同级任务中调整其位置。每个任务最多可拥有2000个子任务。
    • patch
      — 更新指定的任务。该方法支持patch语义。
    • update
      — 更新指定的任务。

Discovering Commands

探索命令

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

Browse resources and methods

浏览资源与方法

gws tasks --help
gws tasks --help

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

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

gws schema tasks.<resource>.<method>

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

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