aitable-workflow-cli 0.1.15 → 0.1.16-beta.1786022310508

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/SingleSelectField /345/215/225/351/200/211/345/255/227/346/256/265.md"

@@ -1,336 +0,0 @@
-# SingleSelectField 单选字段
-
-SingleSelectField，继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理单选类型数据。用于从预设选项中选择单个值，常用于状态、类别等场景。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定记录在该单选字段中选择的选项。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<SelectOption | null>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-
-**返回值**
-
-*   [`Promise<SelectOption | null>`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=ELhg2x3IP0&sheetId=hERWDMS&viewId=qvGDAH2) - 选中的选项，包含id和name属性，如果未选择则返回null
-    
-
-**示例**
-
-```typescript
-// 获取记录的选项值
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  const selectedOption = await statusField.getValueAsync('rec123456');
-  if (selectedOption) {
-    console.log(`选中的状态: ${selectedOption.name} (ID: ${selectedOption.id})`);
-  } else {
-    console.log('未选择任何状态');
-  }
-}
-
-```
-```typescript
-// 获取记录的选项值
-const statusField = sheet.getField('状态');
-if (FieldBase.isFieldOfType(statusField, 'singleSelect')) {
-  const selectedOption = await statusField.getValueAsync('rec123456');
-  if (selectedOption) {
-    Output.log(`选中的状态: ${selectedOption.name} (ID: ${selectedOption.id})`);
-  } else {
-    Output.log('未选择任何状态');
-  }
-}
-
-```
-
-### setValueAsync
-
-设置指定记录在该单选字段中的选项。
-
-```typescript
-setValueAsync: (recordId: string, optionId: string) => Promise<boolean>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `optionId`: `string` - 选项ID
-    
-
-**返回值**
-
-*   `Promise<boolean>`\- 操作是否成功
-    
-
-**示例**
-
-```typescript
-// 设置记录的选项值
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  // 首先获取所有选项，找到目标选项的ID
-  const options = statusField.getOptions();
-  const inProgressOption = options.find(opt => opt.name === '处理中');
-  
-  if (inProgressOption) {
-    // 使用选项ID设置记录值
-    const success = await statusField.setValueAsync('rec123456', inProgressOption.id);
-    if (success) {
-      console.log('状态已更新为处理中');
-    } else {
-      console.log('状态更新失败');
-    }
-  }
-}
-
-```
-```typescript
-// 设置记录的选项值
-const statusField = sheet.getField('状态');
-if (Base.isFieldOfType(statusField, 'singleSelect')) {
-  // 首先获取所有选项，找到目标选项的ID
-  const options = statusField.getOptions();
-  const inProgressOption = options.find(opt => opt.name === '处理中');
-  
-  if (inProgressOption) {
-    // 使用选项ID设置记录值
-    const success = await statusField.setValueAsync('rec123456', inProgressOption.id);
-    if (success) {
-      Output.log('状态已更新为处理中');
-    } else {
-      Output.log('状态更新失败');
-    }
-  }
-}
-
-```
-
-### addOption
-
-添加一个新的选项到单选字段中。
-
-```typescript
-addOption: (name: string) => string
-
-```
-
-**参数**
-
-*   `name`: `string` - 选项名称
-    
-
-**返回值**
-
-*   `string` - 字段ID
-    
-
-**示例**
-
-```typescript
-// 添加一个新选项「待审核」
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  statusField.addOption('待审核');
-}
-
-```
-```typescript
-// 添加一个新选项「待审核」
-const statusField = sheet.getField('状态');
-if (Base.isFieldOfType(statusField, 'singleSelect')) {
-  statusField.addOption('待审核');
-}
-
-```
-
-### addOptions
-
-批量添加多个选项到单选字段中。
-
-```typescript
-addOptions: (optionList: { name: string }[]) => string
-```
-
-**参数**
-
-*   `optionList`: `{ name: string }[]` - 选项列表，每个选项包含名称
-    
-
-**返回值**
-
-*   `string` - 字段ID
-    
-
-**示例**
-
-```typescript
-// 批量添加多个选项
-const priorityField = sheet.getField<SingleSelectField>('优先级');
-if (priorityField) {
-  priorityField.addOptions([
-    { name: '低' },
-    { name: '中' },
-    { name: '高' },
-    { name: '紧急' }
-  ]);
-}
-
-```
-```typescript
-// 批量添加多个选项
-const priorityField = sheet.getField('优先级');
-if (statusFieldBase.isFieldOfType(priorityField, 'singleSelect')) {
-  priorityField.addOptions([
-    { name: '低' },
-    { name: '中' },
-    { name: '高' },
-    { name: '紧急' }
-  ]);
-}
-
-```
-
-### getOptions
-
-获取单选字段的所有选项。
-
-```typescript
-getOptions: () => ISelectFieldOption[]
-
-```
-
-**返回值**
-
-*    [`ISelectFieldOption[]`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=j4GPbzUY3c&sheetId=hERWDMS&viewId=qvGDAH2) - 选项列表，每个选项包含id、name和color属性
-    
-
-**示例**
-
-```typescript
-// 获取所有选项
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  const options = statusField.getOptions();
-  console.log(`共有 ${options.length} 个选项:`);
-  options.forEach(option => {
-    console.log(`- ${option.name} (ID: ${option.id}, 颜色: ${option.color})`);
-  });
-}
-
-```
-```typescript
-// 获取所有选项
-const statusField = sheet.getField('状态');
-if (Base.isFieldOfType(statusField, 'singleSelect')) {
-  const options = statusField.getOptions();
-  Output.log(`共有 ${options.length} 个选项:`);
-  options.forEach(option => {
-    Output.log(`- ${option.name} (ID: ${option.id}, 颜色: ${option.color})`);
-  });
-}
-
-```
-
-### deleteOptionAsync
-
-删除单选字段中的指定选项，由于删除选项会间接影响字段值，所以此方法为异步方法。
-
-```typescript
-deleteOptionAsync: (idOrName: string) => Promise<string>
-```
-
-**参数**
-
-*   `idOrName`: `string` - 选项ID或选项名称
-    
-
-**返回值**
-
-*   `Promise<string>`\- 字段ID
-    
-
-**示例**
-
-```typescript
-// 删除指定选项
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  // 通过选项ID删除
-  await statusField.deleteOptionAsync('opt123456');
-  
-  // 或通过选项名称删除
-  await statusField.deleteOptionAsync('已取消');
-}
-
-```
-```typescript
-// 删除指定选项
-const statusField = sheet.getField('状态');
-if (Base.isFieldOfType(statusField, 'singleSelect')) {
-  // 通过选项ID删除
-  await statusField.deleteOptionAsync('opt123456');
-  
-  // 或通过选项名称删除
-  await statusField.deleteOptionAsync('已取消');
-}
-
-```
-
-### setOptionAsync
-
-修改单选字段中指定选项的配置。
-
-```typescript
-setOptionAsync(nameOrId: string, config: IOptionConfig): Promise<string>
-
-```
-
-**参数**
-
-*   `nameOrId`: `string` - 选项ID或选项名称
-    
-*   `config`: [`IOptionConfig`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=LOSeiToBo3&sheetId=hERWDMS&viewId=qvGDAH2) - 选项配置，目前支持修改name属性
-    
-
-**返回值**
-
-*   `Promise<string>`\- 字段ID
-    
-
-**示例**
-
-```typescript
-// 修改选项名称
-const statusField = sheet.getField<SingleSelectField>('状态');
-if (statusField) {
-  // 通过选项ID修改
-  await statusField.setOptionAsync('opt123456', { name: '已完成' });
-  
-  // 或通过选项名称修改
-  await statusField.setOptionAsync('进行中', { name: '处理中' });
-}
-
-```
-```typescript
-// 修改选项名称
-const statusField = sheet.getField('状态');
-if (Base.isFieldOfType(statusField, 'singleSelect')) {
-  // 通过选项ID修改
-  await statusField.setOptionAsync('opt123456', { name: '已完成' });
-  
-  // 或通过选项名称修改
-  await statusField.setOptionAsync('进行中', { name: '处理中' });
-}
-
-```

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/TelephoneField /347/224/265/350/257/235/345/255/227/346/256/265.md"

@@ -1,99 +0,0 @@
-# TelephoneField 电话字段
-
-`PhoneField`，继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理电话字段数据。用于存储和管理电话号码信息。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定行记录该电话字段的值。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<string | null>
-
-```
-
-**参数**
-
-*   `recordId` : `string` - 记录ID
-    
-
-**返回值**
-
-*   `Promise<string | null>` - 电话号码值，当字段值为空时返回null
-    
-
-**示例**
-
-```typescript
-// 获取电话字段值
-const phoneField = sheet.getField<PhoneField>('联系电话');
-if (phoneField) {
-  const phone = await phoneField.getValueAsync('rec123456');
-  console.log(`联系电话: ${phone ? phone : '未填写'}`);
-}
-
-```
-```typescript
-// 获取电话字段值
-const phoneField = sheet.getField('联系电话');
-if (Base.isFieldOfType(phoneField, 'telephone')) {
-  const phone = await phoneField.getValueAsync('rec123456');
-  Output.log(`联系电话: ${phone ? phone : '未填写'}`);
-}
-
-```
-
-### setValueAsync
-
-设置指定行记录该电话字段的值。
-
-```typescript
-setValueAsync: (recordId: string, val: string) => Promise<boolean>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `val`: `string` - 电话号码值
-    
-
-**返回值**
-
-*   `Promise<boolean>` - 设置是否成功
-    
-
-**重要提示**
-
-调用该API时，请确保电话号码为合法号码，否则更新数据将失败。
-
-**示例**
-
-```typescript
-// 设置电话字段值
-const phoneField = sheet.getField<PhoneField>('联系电话');
-if (phoneField) {
-  const success = await phoneField.setValueAsync('rec123456', '13800138000');
-  if (success) {
-    console.log('电话号码更新成功');
-  } else {
-    console.log('电话号码更新失败');
-  }
-}
-
-```
-```typescript
-// 设置电话字段值
-const phoneField = sheet.getField('联系电话');
-if (Base.isFieldOfType(phoneField, 'telephone')) {
-  const success = await phoneField.setValueAsync('rec123456', '13800138000');
-  if (success) {
-    Output.log('电话号码更新成功');
-  } else {
-    Output.log('电话号码更新失败');
-  }
-}
-
-```

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/TextField /346/226/207/346/234/254/345/255/227/346/256/265.md"

@@ -1,93 +0,0 @@
-# TextField 文本字段
-
-`TextField`，继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理文本字段数据。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定记录在该文本字段的值。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<string | null>
-```
-
-**参数**
-
-*   `recordId` : `string` - 记录ID
-    
-
-**返回值**
-
-*   `Promise<string | null>`\- 文本值，如果记录不存在或值为空则返回null
-    
-
-**示例**
-
-```typescript
-// 获取文本字段值
-const textField = sheet.getField<TextField>('备注');
-if (textField) {
-  const text = await textField.getValueAsync('rec123456');
-  console.log(`备注内容: ${text || '无'}`);
-}
-
-```
-```typescript
-// 获取文本字段值
-const textField = sheet.getField('备注');
-if (Base.isFieldOfType(textField, 'text')) {
-  const text = await textField.getValueAsync('rec123456');
-  Output.log(`备注内容: ${text || '无'}`);
-}
-
-```
-
-### setValueAsync
-
-设置指定记录在该文本字段的值。
-
-```typescript
-setValueAsync: (recordId: string, text: string): Promise<boolean>
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `text`: `string` - 要设置的文本值
-    
-
-**返回值**
-
-*   `Promise<boolean>`\- 设置是否成功
-    
-
-**示例**
-
-```typescript
-// 设置文本字段值
-const textField = sheet.getField<TextField>('备注');
-if (textField) {
-  const success = await textField.setValueAsync('rec123456', '这是一条新的备注内容');
-  if (success) {
-    console.log('文本更新成功');
-  } else {
-    console.log('文本更新失败');
-  }
-}
-
-```
-```typescript
-// 设置文本字段值
-const textField = sheet.getField('备注');
-if (Base.isFieldOfType(textField, 'text')) {
-  const success = await textField.setValueAsync('rec123456', '这是一条新的备注内容');
-  if (success) {
-    Output.log('文本更新成功');
-  } else {
-    Output.log('文本更新失败');
-  }
-}
-
-```