@doubao-apps/ai 0.0.26 → 0.0.27

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/23-/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md

@@ -0,0 +1,270 @@
+# Open API: 设备 / 联系人
+
+选择和添加手机联系人。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [chooseContact](#choosecontact) | 选择手机联系人。 |
+| [addPhoneContact](#addphonecontact) | 添加手机联系人。 |
+
+## API 详情
+
+<a id="choosecontact"></a>
+### chooseContact()
+
+> **chooseContact**(`params`?): `Promise`\<[`ChooseContactResult`](#choosecontactresult)\>
+
+选择手机联系人。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`ChooseContactResult`](#choosecontactresult)\>
+
+<a id="addphonecontact"></a>
+### addPhoneContact()
+
+> **addPhoneContact**(`params`): `Promise`\<`object`\>
+
+添加手机联系人。
+
+#### Parameters
+
+• **params**: [`AddPhoneContactParams`](#addphonecontactparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="choosecontactresult"></a>
+### ChooseContactResult
+
+选取联系人后的返回结果。
+
+#### Properties
+
+##### displayName
+
+> **displayName**: `string`
+
+联系人名称。
+
+##### phoneNumber
+
+> **phoneNumber**: `string`
+
+选中的手机号。
+
+##### phoneNumberList
+
+> **phoneNumberList**: `string`[]
+
+联系人所有手机号。
+
+<a id="addphonecontactparams"></a>
+### AddPhoneContactParams
+
+添加手机联系人的请求参数。
+
+#### Properties
+
+##### addressCity?
+
+> `optional` **addressCity**: `string`
+
+家庭地址城市。
+
+##### addressCountry?
+
+> `optional` **addressCountry**: `string`
+
+家庭地址国家。
+
+##### addressPostalCode?
+
+> `optional` **addressPostalCode**: `string`
+
+家庭地址邮编。
+
+##### addressState?
+
+> `optional` **addressState**: `string`
+
+家庭地址省份。
+
+##### addressStreet?
+
+> `optional` **addressStreet**: `string`
+
+家庭地址街道。
+
+##### email?
+
+> `optional` **email**: `string`
+
+电子邮件。
+
+##### firstName
+
+> **firstName**: `string`
+
+名字。
+
+##### homeAddressCity?
+
+> `optional` **homeAddressCity**: `string`
+
+家庭地址城市。
+
+##### homeAddressCountry?
+
+> `optional` **homeAddressCountry**: `string`
+
+家庭地址国家。
+
+##### homeAddressPostalCode?
+
+> `optional` **homeAddressPostalCode**: `string`
+
+家庭地址邮编。
+
+##### homeAddressState?
+
+> `optional` **homeAddressState**: `string`
+
+家庭地址省份。
+
+##### homeAddressStreet?
+
+> `optional` **homeAddressStreet**: `string`
+
+家庭地址街道。
+
+##### homeFaxNumber?
+
+> `optional` **homeFaxNumber**: `string`
+
+家庭传真。
+
+##### homePhoneNumber?
+
+> `optional` **homePhoneNumber**: `string`
+
+家庭电话。
+
+##### hostNumber?
+
+> `optional` **hostNumber**: `string`
+
+公司电话。
+
+##### lastName?
+
+> `optional` **lastName**: `string`
+
+姓。
+
+##### middleName?
+
+> `optional` **middleName**: `string`
+
+中间名。
+
+##### mobilePhoneNumber?
+
+> `optional` **mobilePhoneNumber**: `string`
+
+手机号。
+
+##### nickName?
+
+> `optional` **nickName**: `string`
+
+昵称。
+
+##### organization?
+
+> `optional` **organization**: `string`
+
+公司。
+
+##### photoFilePath?
+
+> `optional` **photoFilePath**: `string`
+
+头像文件路径。
+
+##### remark?
+
+> `optional` **remark**: `string`
+
+备注。
+
+##### title?
+
+> `optional` **title**: `string`
+
+职位。
+
+##### url?
+
+> `optional` **url**: `string`
+
+个人网站。
+
+##### weChatNumber?
+
+> `optional` **weChatNumber**: `string`
+
+微信号。
+
+##### workAddressCity?
+
+> `optional` **workAddressCity**: `string`
+
+工作地址城市。
+
+##### workAddressCountry?
+
+> `optional` **workAddressCountry**: `string`
+
+工作地址国家。
+
+##### workAddressPostalCode?
+
+> `optional` **workAddressPostalCode**: `string`
+
+工作地址邮编。
+
+##### workAddressState?
+
+> `optional` **workAddressState**: `string`
+
+工作地址省份。
+
+##### workAddressStreet?
+
+> `optional` **workAddressStreet**: `string`
+
+工作地址街道。
+
+##### workFaxNumber?
+
+> `optional` **workFaxNumber**: `string`
+
+工作传真。
+
+##### workPhoneNumber?
+
+> `optional` **workPhoneNumber**: `string`
+
+工作电话。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/24-/350/256/276/345/244/207-/345/212/240/345/257/206.md

@@ -0,0 +1,56 @@
+# Open API: 设备 / 加密
+
+安全随机数能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getRandomValues](#getrandomvalues) | 获取安全随机数。 |
+
+## API 详情
+
+<a id="getrandomvalues"></a>
+### getRandomValues()
+
+> **getRandomValues**(`params`): `Promise`\<[`GetRandomValuesResult`](#getrandomvaluesresult)\>
+
+获取安全随机数。
+
+#### Parameters
+
+• **params**: [`GetRandomValuesParams`](#getrandomvaluesparams)
+
+#### Returns
+
+`Promise`\<[`GetRandomValuesResult`](#getrandomvaluesresult)\>
+
+## 相关类型
+
+<a id="getrandomvaluesparams"></a>
+### GetRandomValuesParams
+
+获取安全随机数的请求参数。
+
+#### Properties
+
+##### length
+
+> **length**: `number`
+
+需要生成的字节数。
+
+<a id="getrandomvaluesresult"></a>
+### GetRandomValuesResult
+
+获取安全随机数的返回结果。
+
+#### Properties
+
+##### randomValues
+
+> **randomValues**: `ArrayBuffer`
+
+生成的随机字节。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/25-/350/256/276/345/244/207-/347/224/265/350/257/235.md

@@ -0,0 +1,41 @@
+# Open API: 设备 / 电话
+
+拨打电话。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [makePhoneCall](#makephonecall) | 拨打电话。 |
+
+## API 详情
+
+<a id="makephonecall"></a>
+### makePhoneCall()
+
+> **makePhoneCall**(`params`): `Promise`\<`object`\>
+
+拨打电话。
+
+#### Parameters
+
+• **params**: [`MakePhoneCallParams`](#makephonecallparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="makephonecallparams"></a>
+### MakePhoneCallParams
+
+#### Properties
+
+##### phoneNumber
+
+> **phoneNumber**: `string`
+
+需要拨打的电话号码

package/dist/contexts/doubao-apps-dev/.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/contexts/doubao-apps-dev/.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 '@byted-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/contexts/doubao-apps-dev/.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"`
+
+短震动类型。