@doubao-apps/ai 0.0.33 → 0.0.34

package/dist/skills/doubao-apps-dev/references/reference/open-api/31-/346/211/253/347/240/201.md

@@ -0,0 +1,58 @@
+# Open API: 扫码
+
+调起扫码并读取扫码结果。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [scanCode](#scancode) | 调起扫码能力。 |
+
+## API 详情
+
+<a id="scancode"></a>
+### scanCode()
+
+调起扫码能力。
+
+## 代码示例
+
+```typescript
+import { scanCode } from '@doubao-apps/framework/api';
+
+const { result, scanType } = await scanCode({
+  onlyFromCamera: true,
+  scanType: ['qrCode']
+});
+
+console.log(result, scanType);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|onlyFromCamera|`boolean`|否|是否仅允许从相机扫码。|
+|scanType|`ScanCodeType[]`|否|允许的扫码类型。|
+
+**类型说明**
+
+- `ScanCodeType`: `"barCode" | "qrCode" | "datamatrix" | "pdf417"`
+
+## 返回值
+
+返回 `Promise<ScanCodeResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|characterSet|`string`|字符集。|
+|path|`string`|当前宿主可识别的页面路径。|
+|rawData|`string`|原始数据，通常为 Base64 字符串。|
+|result|`string`|扫码结果文本。|
+|scanType|`ScanResultType`|扫码结果类型。|
+
+**类型说明**
+
+- `ScanResultType`: `"QR_CODE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "RSS_14" | "RSS_EXPANDED" | "UPC_A" | "UPC_E" | "UPC_EAN_EXTENSION" | "WX_CODE" | "CODE_25"`

package/dist/skills/doubao-apps-dev/references/reference/open-api/32-/345/261/217/345/271/225.md

@@ -0,0 +1,136 @@
+# Open API: 屏幕
+
+屏幕亮度、常亮和截屏/录屏相关能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [UserCaptureScreenListener](#usercapturescreenlistener) | 用户主动截屏事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [getScreenBrightness](#getscreenbrightness) | 获取屏幕亮度。 |
+| [setVisualEffectOnCapture](#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。 |
+| [setScreenBrightness](#setscreenbrightness) | 设置屏幕亮度。 |
+| [setKeepScreenOn](#setkeepscreenon) | 设置屏幕常亮状态。 |
+
+## API 详情
+
+<a id="usercapturescreenlistener"></a>
+### UserCaptureScreenListener()
+
+用户主动截屏事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `void`。
+
+<a id="getscreenbrightness"></a>
+### getScreenBrightness()
+
+获取屏幕亮度。
+
+## 代码示例
+
+```typescript
+import { getScreenBrightness } from '@doubao-apps/framework/api';
+
+const { value } = await getScreenBrightness();
+
+console.log(value);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetScreenBrightnessResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|value|`number`|屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮|
+
+<a id="setvisualeffectoncapture"></a>
+### setVisualEffectOnCapture()
+
+设置截屏或录屏时的视觉表现。
+
+## 代码示例
+
+```typescript
+import { setVisualEffectOnCapture } from '@doubao-apps/framework/api';
+
+await setVisualEffectOnCapture({ visualEffect: 'hidden' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|visualEffect|`CaptureVisualEffect`|否|截屏或录屏时的视觉表现。|
+
+**类型说明**
+
+- `CaptureVisualEffect`: `"none" | "hidden"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="setscreenbrightness"></a>
+### setScreenBrightness()
+
+设置屏幕亮度。
+
+## 代码示例
+
+```typescript
+import { setScreenBrightness } from '@doubao-apps/framework/api';
+
+await setScreenBrightness({ value: 0.8 });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|value|`number`|是|屏幕亮度值，范围 0 ~ 1。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="setkeepscreenon"></a>
+### setKeepScreenOn()
+
+设置屏幕常亮状态。
+
+## 代码示例
+
+```typescript
+import { setKeepScreenOn } from '@doubao-apps/framework/api';
+
+await setKeepScreenOn({ keepScreenOn: true });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|keepScreenOn|`boolean`|是|是否保持屏幕常亮。|
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/33-/351/234/207/345/212/250.md

@@ -0,0 +1,62 @@
+# Open API: 震动
+
+触发短震动和长震动。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [vibrateShort](#vibrateshort) | 触发短震动。 |
+| [vibrateLong](#vibratelong) | 触发长震动。 |
+
+## API 详情
+
+<a id="vibrateshort"></a>
+### vibrateShort()
+
+触发短震动。
+
+## 代码示例
+
+```typescript
+import { vibrateShort } from '@doubao-apps/framework/api';
+
+await vibrateShort({ type: 'medium' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|type|`VibrateShortType`|否|震动强度类型。|
+
+**类型说明**
+
+- `VibrateShortType`: `"heavy" | "medium" | "light"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="vibratelong"></a>
+### vibrateLong()
+
+触发长震动。
+
+## 代码示例
+
+```typescript
+import { vibrateLong } from '@doubao-apps/framework/api';
+
+await vibrateLong();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/34-/346/226/207/344/273/266/347/263/273/347/273/237.md

@@ -0,0 +1,73 @@
+# Open API: 文件系统
+
+文件读写、目录管理和文件信息操作。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getFileSystemManager](#getfilesystemmanager) | 获取文件系统管理器。 |
+
+## API 详情
+
+<a id="getfilesystemmanager"></a>
+### getFileSystemManager()
+
+获取文件系统管理器。
+
+## 代码示例
+
+```typescript
+import { getFileSystemManager } from '@doubao-apps/framework/api';
+
+const fs = getFileSystemManager();
+const { data } = await fs.readFile({
+  filePath: '/tmp/profile.json',
+  encoding: 'utf-8'
+});
+
+console.log(data);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `FileSystemManager`。
+
+|字段名|类型|说明|
+|---|---|---|
+|access|`(params: AccessParams) => Promise<void>`|-|
+|accessSync|`(params: AccessParams) => void`|-|
+|appendFile|`(params: AppendFileParams) => Promise<void>`|-|
+|appendFileSync|`(params: AppendFileParams) => void`|-|
+|copyFile|`(params: CopyFileParams) => Promise<void>`|-|
+|copyFileSync|`(params: CopyFileParams) => void`|-|
+|getFileInfo|`(params: GetFileInfoParams) => Promise<GetFileInfoResult>`|-|
+|getSavedFileList|`() => Promise<GetSavedFileListResult>`|-|
+|mkdir|`(params: MkdirParams) => Promise<void>`|-|
+|mkdirSync|`(params: MkdirParams) => void`|-|
+|readdir|`(params: ReaddirParams) => Promise<ReaddirResult>`|-|
+|readdirSync|`(params: ReaddirParams) => ReaddirResult`|-|
+|readFile|`(params: ReadFileParams) => Promise<ReadFileResult>`|-|
+|readFileSync|`(params: ReadFileParams) => ReadFileResult`|-|
+|removeSavedFile|`(params: RemoveSavedFileParams) => Promise<void>`|-|
+|rename|`(params: RenameParams) => Promise<void>`|-|
+|renameSync|`(params: RenameParams) => void`|-|
+|rmdir|`(params: RmdirParams) => Promise<void>`|-|
+|rmdirSync|`(params: RmdirParams) => void`|-|
+|saveFile|`(params: SaveFileParams) => Promise<SaveFileResult>`|-|
+|saveFileSync|`(params: SaveFileParams) => SaveFileResult`|-|
+|stat|`(params: StatParams) => Promise<StatResult>`|-|
+|statSync|`(params: StatParams) => StatResult`|-|
+|truncate|`(params: TruncateParams) => Promise<void>`|-|
+|truncateSync|`(params: TruncateParams) => void`|-|
+|unlink|`(params: UnlinkParams) => Promise<void>`|-|
+|unlinkSync|`(params: UnlinkParams) => void`|-|
+|unzip|`(params: UnzipParams) => Promise<void>`|-|
+|writeFile|`(params: WriteFileParams) => Promise<void>`|-|
+|writeFileSync|`(params: WriteFileParams) => void`|-|

package/dist/skills/doubao-apps-dev/references/reference/open-api/README.md

@@ -6,3 +6,37 @@
 
 | 分组 | 说明 | API 数量 | 详细文档 |
 | --- | --- | ---: | --- |
+| 基础 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 4 | [查看](./01-基础.md) |
+| 系统 | 宿主基础信息、窗口信息和系统设置。 | 7 | [查看](./02-系统.md) |
+| 定位 | 获取设备当前的地理位置信息。 | 11 | [查看](./03-定位.md) |
+| 存储 | 本地缓存；带 Sync 后缀的是同步 API。 | 10 | [查看](./04-存储.md) |
+| 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./05-路由.md) |
+| 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./06-交互.md) |
+| 输入 | 键盘和输入框选区能力。 | 2 | [查看](./07-输入.md) |
+| 网络 | 网络请求与 WebSocket。 | 2 | [查看](./08-网络.md) |
+| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./09-媒体.md) |
+| 业务能力 | 开放业务能力、隐私设置、上下文和外部应用打开。 | 11 | [查看](./10-业务能力.md) |
+| 登录 | 豆包登录和登录结果回传能力。 | 3 | [查看](./11-登录.md) |
+| 支付 | 订单创建、签名和支付能力。 | 6 | [查看](./12-支付.md) |
+| 数据分析 | 监控上报、事件和数据分析上报。 | 1 | [查看](./13-数据分析.md) |
+| 蓝牙 | 蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。 | 19 | [查看](./14-蓝牙.md) |
+| Wi-Fi | Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。 | 7 | [查看](./15-wi-fi.md) |
+| 加速度计 | 加速度计监听能力。 | 3 | [查看](./16-加速度计.md) |
+| iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./17-ibeacon.md) |
+| 罗盘 | 罗盘监听能力。 | 3 | [查看](./18-罗盘.md) |
+| 设备方向 | 设备方向监听能力。 | 3 | [查看](./19-设备方向.md) |
+| 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./20-陀螺仪.md) |
+| 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./21-设备-网络.md) |
+| 短信 | 拉起系统短信发送面板。 | 1 | [查看](./22-短信.md) |
+| 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./23-无障碍.md) |
+| 基础信息 | 设备品牌、型号、系统、内存和性能等级。 | 2 | [查看](./24-基础信息.md) |
+| 电池 | 电池信息读取与变化监听。 | 2 | [查看](./25-电池.md) |
+| 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./26-日历.md) |
+| 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./27-剪贴板.md) |
+| 联系人 | 选择和添加手机联系人。 | 2 | [查看](./28-联系人.md) |
+| 加密 | 安全随机数能力。 | 1 | [查看](./29-加密.md) |
+| 电话 | 拨打电话。 | 1 | [查看](./30-电话.md) |
+| 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./31-扫码.md) |
+| 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./32-屏幕.md) |
+| 震动 | 触发短震动和长震动。 | 2 | [查看](./33-震动.md) |
+| 文件系统 | 文件读写、目录管理和文件信息操作。 | 1 | [查看](./34-文件系统.md) |