@doubao-apps/create 0.0.26 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/26-/350/256/276/345/244/207-/346/211/253/347/240/201.md

@@ -0,0 +1,100 @@
+# Open API: 设备 / 扫码
+
+调起扫码并读取扫码结果。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [scanCode](#scancode) | 调起扫码能力。 |
+
+## API 详情
+
+<a id="scancode"></a>
+### scanCode()
+
+> **scanCode**(`params`?): `Promise`\<[`ScanCodeResult`](#scancoderesult)\>
+
+调起扫码能力。
+
+#### Parameters
+
+• **params?**: [`ScanCodeParams`](#scancodeparams)
+
+#### Returns
+
+`Promise`\<[`ScanCodeResult`](#scancoderesult)\>
+
+## 相关类型
+
+<a id="scancodeparams"></a>
+### ScanCodeParams
+
+扫码请求参数。
+
+#### Properties
+
+##### onlyFromCamera?
+
+> `optional` **onlyFromCamera**: `boolean`
+
+是否仅允许从相机扫码。
+
+##### scanType?
+
+> `optional` **scanType**: [`ScanCodeType`](#scancodetype)[]
+
+允许的扫码类型。
+
+<a id="scancoderesult"></a>
+### ScanCodeResult
+
+扫码返回结果。
+
+#### Properties
+
+##### characterSet
+
+> **characterSet**: `string`
+
+字符集。
+
+##### path
+
+> **path**: `string`
+
+当前宿主可识别的页面路径。
+
+##### rawData
+
+> **rawData**: `string`
+
+原始数据，通常为 Base64 字符串。
+
+##### result
+
+> **result**: `string`
+
+扫码结果文本。
+
+##### scanType
+
+> **scanType**: [`ScanResultType`](#scanresulttype)
+
+扫码结果类型。
+
+<a id="scancodetype"></a>
+### ScanCodeType
+
+> **ScanCodeType**: `"barCode"` \| `"qrCode"` \| `"datamatrix"` \| `"pdf417"`
+
+扫码类型。
+
+<a id="scanresulttype"></a>
+### 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/template-starter/.ai/reference/open-api/27-/350/256/276/345/244/207-/345/261/217/345/271/225.md

@@ -0,0 +1,173 @@
+# Open API: 设备 / 屏幕
+
+屏幕亮度、常亮和截屏/录屏相关能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getScreenBrightness](#getscreenbrightness) | 获取屏幕亮度。 |
+| [setVisualEffectOnCapture](#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。<br><br>控制截屏或录屏时的视觉效果。 |
+| [setScreenBrightness](#setscreenbrightness) | 设置屏幕亮度。 |
+| [setKeepScreenOn](#setkeepscreenon) | 设置屏幕常亮状态。 |
+| [onUserCaptureScreen](#onusercapturescreen) | 监听用户主动截屏事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="getscreenbrightness"></a>
+### getScreenBrightness()
+
+> **getScreenBrightness**(`params`?): `Promise`\<[`GetScreenBrightnessResult`](#getscreenbrightnessresult)\>
+
+获取屏幕亮度。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetScreenBrightnessResult`](#getscreenbrightnessresult)\>
+
+<a id="setvisualeffectoncapture"></a>
+### setVisualEffectOnCapture()
+
+> **setVisualEffectOnCapture**(`params`?): `Promise`\<`object`\>
+
+设置截屏或录屏时的视觉表现。
+
+#### Parameters
+
+• **params?**: [`SetVisualEffectOnCaptureParams`](#setvisualeffectoncaptureparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+控制截屏或录屏时的视觉效果。
+
+<a id="setscreenbrightness"></a>
+### setScreenBrightness()
+
+> **setScreenBrightness**(`params`): `Promise`\<`object`\>
+
+设置屏幕亮度。
+
+#### Parameters
+
+• **params**: [`SetScreenBrightnessParams`](#setscreenbrightnessparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="setkeepscreenon"></a>
+### setKeepScreenOn()
+
+> **setKeepScreenOn**(`params`): `Promise`\<`object`\>
+
+设置屏幕常亮状态。
+
+#### Parameters
+
+• **params**: [`SetKeepScreenOnParams`](#setkeepscreenonparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="onusercapturescreen"></a>
+### onUserCaptureScreen()
+
+> **onUserCaptureScreen**(`handler`): () => `void`
+
+监听用户主动截屏事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onUserCaptureScreen } from '@doubao-apps/framework/api';
+
+const off = onUserCaptureScreen(() => {
+  console.log('用户截屏了');
+});
+
+off();
+```
+
+## 相关类型
+
+<a id="getscreenbrightnessresult"></a>
+### GetScreenBrightnessResult
+
+#### Properties
+
+##### value
+
+> **value**: `number`
+
+屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮
+
+<a id="setvisualeffectoncaptureparams"></a>
+### SetVisualEffectOnCaptureParams
+
+设置截屏或录屏视觉效果的请求参数。
+
+#### Properties
+
+##### visualEffect?
+
+> `optional` **visualEffect**: [`CaptureVisualEffect`](#capturevisualeffect)
+
+截屏或录屏时的视觉表现。
+
+<a id="capturevisualeffect"></a>
+### CaptureVisualEffect
+
+> **CaptureVisualEffect**: `"none"` \| `"hidden"`
+
+录屏或截屏时的视觉表现。
+
+<a id="setscreenbrightnessparams"></a>
+### SetScreenBrightnessParams
+
+设置屏幕亮度的请求参数。
+
+#### Properties
+
+##### value
+
+> **value**: `number`
+
+屏幕亮度值，范围 0 ~ 1。
+
+<a id="setkeepscreenonparams"></a>
+### SetKeepScreenOnParams
+
+设置屏幕常亮的请求参数。
+
+#### Properties
+
+##### keepScreenOn
+
+> **keepScreenOn**: `boolean`
+
+是否保持屏幕常亮。

package/dist/template-starter/.ai/reference/open-api/28-/350/256/276/345/244/207-/351/234/207/345/212/250.md

@@ -0,0 +1,66 @@
+# Open API: 设备 / 震动
+
+触发短震动和长震动。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [vibrateShort](#vibrateshort) | 触发短震动。 |
+| [vibrateLong](#vibratelong) | 触发长震动。 |
+
+## API 详情
+
+<a id="vibrateshort"></a>
+### vibrateShort()
+
+> **vibrateShort**(`params`?): `Promise`\<`object`\>
+
+触发短震动。
+
+#### Parameters
+
+• **params?**: [`VibrateShortParams`](#vibrateshortparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="vibratelong"></a>
+### vibrateLong()
+
+> **vibrateLong**(`params`?): `Promise`\<`object`\>
+
+触发长震动。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="vibrateshortparams"></a>
+### VibrateShortParams
+
+短震动请求参数。
+
+#### Properties
+
+##### type?
+
+> `optional` **type**: [`VibrateShortType`](#vibrateshorttype)
+
+震动强度类型。
+
+<a id="vibrateshorttype"></a>
+### VibrateShortType
+
+> **VibrateShortType**: `"heavy"` \| `"medium"` \| `"light"`
+
+短震动类型。

package/dist/template-starter/.ai/reference/open-api/README.md

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