aitable-workflow-cli 0.1.13-beta.1

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/RatingField /350/257/204/345/210/206/345/255/227/346/256/265.md"

@@ -0,0 +1,89 @@
+---
+title: RatingField 评分字段
+category: reference
+sources: [18-开发者指南/AI表格对象模型API参考文档/Field 模块/RatingField 评分字段.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [RatingField, 评分字段, Field API]
+aliases: [评分字段, rating]
+confidence: high
+summary: RatingField 是 AI 表格对象模型中的评分字段类型，支持设置评分范围（最小值 0/1，最大值 2-10）和图标类型，常用于评价、打分等场景。
+---
+
+> RatingField 用于处理评分类数据，支持自定义评分范围和图标类型（如星形），常用于满意度评价、质量打分等场景。
+
+## 核心特性
+
+- 继承自基础 Field 类
+- 支持设置评分范围：最小值支持 0 或 1，最大值支持 2~10
+- 支持自定义评分图标
+
+## 字段特有方法
+
+### getValueAsync / setValueAsync
+
+读取和设置评分值。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<number | null>
+setValueAsync: (recordId: string, val: number) => Promise<boolean>
+```
+
+**参数说明**
+
+- `val` 必须为最小值到最大值之间的整数
+
+**示例**
+
+```typescript
+const ratingField = sheet.getField<RatingField>('满意度评分');
+if (ratingField) {
+  const rating = await ratingField.getValueAsync('rec123456');
+  console.log(`满意度评分: ${rating !== null ? rating : '未评分'}`);
+
+  await ratingField.setValueAsync('rec123456', 4);
+}
+```
+
+### getMin / setMin
+
+获取或设置评分最小值（支持 0 或 1）。
+
+```typescript
+getMin: () => number
+setMin: (val: number) => string
+```
+
+### getMax / setMax
+
+获取或设置评分最大值（支持 2~10 之间的整数）。
+
+```typescript
+getMax: () => number
+setMax: (val: number) => string
+```
+
+### getIcon / setIcon
+
+获取或设置评分图标类型。
+
+```typescript
+getIcon: () => RatingIconType
+setIcon: (icon: RatingIconType) => string
+```
+
+**示例**
+
+```typescript
+ratingField.setIcon('star'); // 设置为星形图标
+```
+
+## See Also
+
+- [Field 模块](./Field%20模块.md)
+- [NumberField 数字字段](./NumberField%20数字字段.md)
+- [ProgressField 进度字段](./ProgressField%20进度字段.md)
+
+## Sources
+
+- [RatingField 评分字段](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/Record /346/250/241/345/235/227.md"

@@ -0,0 +1,100 @@
+---
+title: Record 模块 API 参考
+category: reference
+sources: [18-开发者指南/AI表格脚本插件 开发指南/Record 模块.md, 18-开发者指南/AI表格对象模型API参考文档/Record 模块.md, 18-开发者指南/AI表格边栏插件 开发指南/Record 模块.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [Record, 记录, 单元格, CellValue, 元数据, API]
+aliases: [Record API, 记录模块]
+confidence: high
+summary: Record 模块表示数据表中的单条记录，提供基本信息查询（ID/有效性/所属表）、单元格值获取（单个/全部）和记录元数据（创建者/修改者/时间戳）等方法，适用于边栏插件和脚本插件。
+---
+
+> Record 模块表示数据表中的单条记录（行），提供访问和操作记录数据的方法。通过 Sheet 模块的 `getRecordAsync` 或 `getRecordsAsync` 获取 Record 实例后，即可调用其 API 读取字段值、查询创建/修改信息等。
+
+## 基本信息方法
+
+| 方法 | 返回值 | 说明 |
+|------|--------|------|
+| `isValid()` | `boolean` | 记录是否有效（未被删除） |
+| `getSheetId()` | `string` | 所属数据表 ID |
+| `getId()` | `string` | 记录 ID |
+
+```typescript
+const record = await sheet.getRecordAsync('rec123456');
+if (record && record.isValid()) {
+  console.log(`记录 ID: ${record.getId()}`);
+  console.log(`所属数据表: ${record.getSheetId()}`);
+}
+```
+
+## 字段值获取方法
+
+### getCellValue
+
+获取指定字段的值，返回 `CellValue | null`。支持按字段 ID 或字段名称查询。
+
+```typescript
+getCellValue: (fieldIdOrName: string) => CellValue | null
+```
+
+```typescript
+const title = record.getCellValue('标题');
+const dueDate = record.getCellValue('截止日期');
+if (dueDate) {
+  console.log(`截止日期: ${new Date(dueDate).toLocaleDateString()}`);
+}
+```
+
+返回值结构因字段类型而异，详见《字段数据结构》。
+
+### getCellValues
+
+获取所有字段的值，返回 `Record<string, CellValue>` 映射。
+
+```typescript
+getCellValues: (options?: IGetCellValuesOptions) => Record<string, CellValue>
+
+interface IGetCellValuesOptions {
+  returnFieldsById?: boolean;
+}
+```
+
+```typescript
+// 默认使用字段名称作为键
+const allValues = record.getCellValues();
+Object.entries(allValues).forEach(([fieldName, value]) => {
+  console.log(`- ${fieldName}: ${JSON.stringify(value)}`);
+});
+
+// 使用字段 ID 作为键
+const valuesById = record.getCellValues({ returnFieldsById: true });
+```
+
+## 记录元数据方法
+
+### getCreatedBy / getLastModifiedBy
+
+获取记录的创建者/最后修改者信息，返回 `UserCellValue | null`。
+
+### getCreatedTime / getLastModifiedTime
+
+获取记录的创建时间/最后修改时间，返回毫秒时间戳 `number`。
+
+```typescript
+const createdTime = record.getCreatedTime();
+const updatedTime = record.getLastModifiedTime();
+const daysSinceUpdate = Math.floor((Date.now() - updatedTime) / (24 * 60 * 60 * 1000));
+console.log(`上次更新已过去 ${daysSinceUpdate} 天`);
+```
+
+## See Also
+
+- [Sheet 模块](../references/Sheet%20模块.md)
+- [Field 模块](../references/Field%20模块.md)
+- [字段数据结构](../references/字段数据结构.md)
+- [核心知识](../concepts/核心知识.md)
+
+## Sources
+
+- [Record 模块](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_iShZLWoM3o)

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/RichTextField /345/257/214/346/226/207/346/234/254/345/255/227/346/256/265.md"

@@ -0,0 +1,62 @@
+---
+title: RichTextField 富文本字段
+category: reference
+sources: [18-开发者指南/AI表格对象模型API参考文档/Field 模块/RichTextField 富文本字段.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [RichTextField, 富文本字段, Field API]
+aliases: [富文本字段, richText]
+confidence: high
+summary: RichTextField 是 AI 表格对象模型中的富文本字段类型，支持文本格式化、链接、列表等富文本内容，返回 Markdown 格式数据。
+---
+
+> RichTextField 用于处理富文本数据，支持文本格式化、链接、列表等富文本内容。返回值为包含 Markdown 格式的 RichTextValue 对象。
+
+## 核心特性
+
+- 继承自基础 Field 类
+- 支持文本格式化、链接、列表等富文本内容
+- 返回 Markdown 格式的富文本数据
+
+## 字段特有方法
+
+### getValueAsync
+
+获取指定记录的富文本值。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<RichTextValue | null>
+```
+
+**参数**
+
+- `recordId`: `string` - 记录 ID
+
+**返回值**
+
+- `Promise<RichTextValue | null>` - 包含 Markdown 格式的富文本内容；字段值为空时返回 `null`
+
+**示例**
+
+```typescript
+const richTextField = sheet.getField<RichTextField>('详细描述');
+if (richTextField) {
+  const richText = await richTextField.getValueAsync('rec123456');
+  console.log(`详细描述: ${richText ? richText : '未填写'}`);
+}
+```
+
+## 注意事项
+
+- 当前仅提供 `getValueAsync` 读取方法
+- 返回的 RichTextValue 包含 Markdown 格式的内容
+
+## See Also
+
+- [Field 模块](./Field%20模块.md)
+- [TextField 文本字段](./TextField%20文本字段.md)
+- [PrimaryField 主键文档字段](./PrimaryField%20主键文档字段.md)
+
+## Sources
+
+- [RichTextField 富文本字段](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/Sheet /346/250/241/345/235/227.md"

@@ -0,0 +1,222 @@
+---
+title: Sheet 模块 API 参考
+category: reference
+sources: [18-开发者指南/AI表格对象模型API参考文档/Sheet 模块.md, 18-开发者指南/AI表格脚本插件 开发指南/Sheet 模块.md, 18-开发者指南/AI表格边栏插件 开发指南/Sheet 模块.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [Sheet, 数据表, API, JSAPI, AI表格]
+aliases: [数据表模块, Sheet API]
+confidence: high
+summary: Sheet（数据表）模块的完整 API 参考，涵盖基本信息管理、字段管理、视图管理和记录操作四大类方法，适用于边栏插件和脚本插件开发。
+---
+
+> Sheet 即数据表，是 AI 表格中负责维护数据与数据之间联系的核心对象。通过 Sheet API，开发者可以操作数据表的基本信息、字段、视图和记录，是插件开发中最常用的模块之一。
+
+## 获取 Sheet 实例
+
+通过 `Base` 对象获取 Sheet 实例：
+
+```typescript
+// 边栏插件
+const sheet = DingdocsScript.base.getActiveSheet();
+const sheet = DingdocsScript.base.getSheet('数据表1');
+
+// 脚本插件
+const sheet = Base.getActiveSheet();
+const sheet = Base.getSheet('数据表1');
+```
+
+## 基本信息方法
+
+### getId
+
+获取当前数据表 ID，返回 `string`。
+
+```typescript
+const sheetId = sheet.getId();
+```
+
+### getName / setName
+
+获取或设置数据表名称。`setName` 返回 Sheet 自身，支持链式调用。
+
+```typescript
+const name = sheet.getName();
+sheet.setName('销售记录');
+// 链式调用
+sheet.setName('客户信息').getFields();
+```
+
+名称限制：不超过 100 字符，不能包含 `/\?*[ ]:`，不能与已有表同名。
+
+### getDesc / setDesc
+
+获取或设置数据表描述。`getDesc` 无描述时返回 `undefined`，`setDesc` 返回 Sheet 自身。
+
+```typescript
+const desc = sheet.getDesc();
+sheet.setDesc('本表用于记录客户基本信息');
+```
+
+## 字段管理方法
+
+### isFieldExist
+
+判断指定 ID 的字段是否存在，返回 `boolean`。
+
+```typescript
+sheet.isFieldExist('fld123456'); // true | false
+```
+
+### getFields / getField / getFieldsByType
+
+- `getFields()` — 获取所有字段列表，返回 `Field[]`
+- `getField(idOrName)` — 按 ID 或名称获取单个字段，返回 `Field | null`
+- `getFieldsByType(type)` — 按类型筛选字段，返回 `Field<T>[]`
+
+```typescript
+const fields = sheet.getFields();
+const field = sheet.getField('客户姓名');
+const numberFields = sheet.getFieldsByType('number');
+```
+
+边栏插件中建议使用泛型获取更好的类型提示：
+
+```typescript
+const field = sheet.getField<AttachmentField>(idOrName);
+const urls = field.getAttachmentUrls('recordId');
+```
+
+脚本插件中建议使用 `Base.isFieldOfType` 进行类型判断：
+
+```typescript
+if (Base.isFieldOfType(field, 'singleSelect')) {
+  field.addOption('新选项');
+}
+```
+
+### insertField
+
+插入新字段，参数为名称、类型和可选属性，返回 `Field`。字段属性结构因类型而异，详见《字段数据结构》。
+
+```typescript
+const textField = sheet.insertField('备注', 'text');
+```
+
+### updateField / updateFieldAsync
+
+- `updateField(field)` — 更新字段配置（不含类型变更），返回 `Field`
+- `updateFieldAsync(id, field)` — 异步更新字段配置（支持类型变更），返回 `Promise<Field>`
+
+### deleteField
+
+按 ID 或名称删除字段，返回 Sheet 自身。不能删除主键字段或最后一个字段。
+
+```typescript
+sheet.deleteField('临时备注');
+// 链式调用
+sheet.deleteField('不需要的字段').setName('更新后的表名');
+```
+
+## 视图管理方法
+
+### getViews / getView / getActiveView
+
+- `getViews()` — 获取所有视图，返回 `View[]`
+- `getView(idOrName)` — 按 ID 或名称获取视图，返回 `View | null`
+- `getActiveView()` — 获取当前激活视图，返回 `View | null`
+
+### insertView / updateView / deleteView
+
+- `insertView(config)` — 插入视图，返回 `View`
+- `updateView(id, config)` — 更新视图，返回 `View`
+- `deleteView(idOrName)` — 删除视图，返回 Sheet 自身
+
+```typescript
+const view = sheet.insertView({
+  name: '新建的表格视图',
+  type: 'Grid',
+  desc: '由插件创建的表格视图',
+});
+```
+
+## 记录操作方法
+
+### getRecordAsync
+
+获取单条记录，返回 `Promise<Record | null>`。
+
+```typescript
+const record = await sheet.getRecordAsync('rec123456');
+if (record) {
+  console.log(record.getCellValue('标题'));
+}
+```
+
+### getRecordsAsync
+
+分页加载记录，返回 `Promise<GetRecordsResult>`。每页最多 100 条，通过游标分页加载全部记录。
+
+```typescript
+const result = await sheet.getRecordsAsync({ pageSize: 50 });
+
+// 分页加载所有记录
+let hasMore = true, cursor = '';
+const allRecords = [];
+while (hasMore) {
+  const result = await sheet.getRecordsAsync({ pageSize: 100, cursor });
+  allRecords.push(...result.records);
+  hasMore = result.hasMore;
+  cursor = result.cursor;
+}
+```
+
+### insertRecordsAsync
+
+批量插入记录（最多 500 条），返回 `Promise<Record[]>`。
+
+```typescript
+const records = await sheet.insertRecordsAsync([
+  { fields: { '标题': '新任务', '状态': '待处理' } },
+  { fields: { '标题': '另一个任务', '状态': '进行中' } }
+]);
+```
+
+### updateRecordsAsync
+
+批量更新记录（最多 100 条），只更新指定字段，返回 `Promise<Record[]>`。
+
+```typescript
+await sheet.updateRecordsAsync([
+  { id: 'rec123', fields: { '状态': '已完成' } }
+]);
+```
+
+### deleteRecordsAsync
+
+删除一条或多条记录（最多 100 条），返回 `Promise<void>`。
+
+```typescript
+await sheet.deleteRecordsAsync(['rec123', 'rec456']);
+```
+
+## 注意事项
+
+- 记录操作均为异步方法，需使用 `await`
+- 字段标识符可以是字段 ID 或字段名称
+- 返回的记录已经过权限过滤，只包含当前用户有权限查看的记录
+- 字段值的读写结构因字段类型而异，详见《字段数据结构》
+- 记录总数超过表格限制时插入操作会失败
+
+## See Also
+
+- [Base 模块](../references/Base%20模块.md)
+- [Field 模块](../references/Field%20模块.md)
+- [View 模块](../references/View%20模块.md)
+- [Record 模块](../references/Record%20模块.md)
+- [字段数据结构](../references/字段数据结构.md)
+
+## Sources
+
+- [Sheet 模块](https://alidocs.dingtalk.com/i/nodes/pYLaezmVNGmDXOMxumrpZllKJrMqPxX6?iframeQuery=anchorId%3DX02mk15wsqsz7clll7zlo)
+- [Sheet 模块](https://alidocs.dingtalk.com/i/nodes/wva2dxOW4kO6dpRacBjKb7kd8bkz3BRL?iframeQuery=anchorId%3DX02mk15wsqsz7clll7zlo)

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/SingleSelectField /345/215/225/351/200/211/345/255/227/346/256/265.md"

@@ -0,0 +1,106 @@
+---
+title: SingleSelectField 单选字段
+category: reference
+sources: [18-开发者指南/AI表格对象模型API参考文档/Field 模块/SingleSelectField 单选字段.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [SingleSelectField, 单选字段, Field API, 选项管理]
+aliases: [单选字段, singleSelect]
+confidence: high
+summary: SingleSelectField 是 AI 表格对象模型中的单选字段类型，用于从预设选项中选择单个值。提供选项的增删改查和记录值的读写功能，常用于状态、类别等场景。
+---
+
+> SingleSelectField 用于从预设选项中选择单个值，常用于状态管理、类别分类等场景。提供完整的选项管理（增删改查）和记录值读写功能。
+
+## 核心特性
+
+- 继承自基础 Field 类
+- 单选模式，每条记录只能选择一个选项
+- 提供选项的完整生命周期管理
+
+## 字段特有方法
+
+### getValueAsync
+
+获取指定记录中选择的选项。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<SelectOption | null>
+```
+
+**返回值**
+
+- `Promise<SelectOption | null>` - 包含 `id` 和 `name` 属性的选项对象；未选择时返回 `null`
+
+### setValueAsync
+
+设置指定记录的单选选项（通过选项 ID）。
+
+```typescript
+setValueAsync: (recordId: string, optionId: string) => Promise<boolean>
+```
+
+**示例**
+
+```typescript
+const statusField = sheet.getField<SingleSelectField>('状态');
+if (statusField) {
+  const options = statusField.getOptions();
+  const inProgressOption = options.find(opt => opt.name === '处理中');
+  if (inProgressOption) {
+    await statusField.setValueAsync('rec123456', inProgressOption.id);
+  }
+}
+```
+
+### addOption / addOptions
+
+添加单个或批量添加多个选项。
+
+```typescript
+addOption: (name: string) => string
+addOptions: (optionList: { name: string }[]) => string
+```
+
+### getOptions
+
+获取所有选项列表。
+
+```typescript
+getOptions: () => ISelectFieldOption[]
+```
+
+**返回值**
+
+- `ISelectFieldOption[]` - 选项列表，包含 `id`、`name` 和 `color` 属性
+
+### deleteOptionAsync
+
+删除指定选项（异步，会影响已有字段值）。
+
+```typescript
+deleteOptionAsync: (idOrName: string) => Promise<string>
+```
+
+### setOptionAsync
+
+修改指定选项的配置。
+
+```typescript
+setOptionAsync(nameOrId: string, config: IOptionConfig): Promise<string>
+```
+
+**示例**
+
+```typescript
+await statusField.setOptionAsync('进行中', { name: '处理中' });
+```
+
+## See Also
+
+- [Field 模块](./Field%20模块.md)
+- [MultiSelectField 多选字段](./MultiSelectField%20多选字段.md)
+
+## Sources
+
+- [SingleSelectField 单选字段](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)

package/templates/support-qa/profiles/aitable/wiki/faq-support/.kb/wiki/references/TelephoneField /347/224/265/350/257/235/345/255/227/346/256/265.md"

@@ -0,0 +1,65 @@
+---
+title: TelephoneField 电话字段
+category: reference
+sources: [18-开发者指南/AI表格对象模型API参考文档/Field 模块/TelephoneField 电话字段.md]
+created: 2026-07-20
+updated: 2026-07-20
+tags: [TelephoneField, 电话字段, Field API]
+aliases: [电话字段, telephone, PhoneField]
+confidence: high
+summary: TelephoneField（PhoneField）是 AI 表格对象模型中的电话字段类型，用于存储和管理电话号码。设置值时需确保号码合法，否则更新将失败。
+---
+
+> TelephoneField（代码中类名为 PhoneField）用于存储和管理电话号码信息。设置电话号码时要求输入合法号码，非法号码将导致更新失败。
+
+## 核心特性
+
+- 继承自基础 Field 类
+- 存储字符串类型的电话号码
+- 写入时进行号码合法性校验
+
+## 字段特有方法
+
+### getValueAsync
+
+获取指定记录的电话号码值。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<string | null>
+```
+
+**返回值**
+
+- `Promise<string | null>` - 电话号码字符串；字段值为空时返回 `null`
+
+### setValueAsync
+
+设置指定记录的电话号码值。
+
+```typescript
+setValueAsync: (recordId: string, val: string) => Promise<boolean>
+```
+
+**重要提示：请确保电话号码为合法号码，否则更新将失败。**
+
+**示例**
+
+```typescript
+const phoneField = sheet.getField<PhoneField>('联系电话');
+if (phoneField) {
+  const phone = await phoneField.getValueAsync('rec123456');
+  console.log(`联系电话: ${phone ? phone : '未填写'}`);
+
+  const success = await phoneField.setValueAsync('rec123456', '13800138000');
+}
+```
+
+## See Also
+
+- [Field 模块](./Field%20模块.md)
+- [TextField 文本字段](./TextField%20文本字段.md)
+- [UrlField 链接字段](./UrlField%20链接字段.md)
+
+## Sources
+
+- [TelephoneField 电话字段](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)