@doubao-apps/ai 0.0.26 → 0.0.27

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/11-/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md

@@ -0,0 +1,104 @@
+# Open API: 设备 / 加速度计
+
+加速度计监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startAccelerometer](#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
+| [stopAccelerometer](#stopaccelerometer) | 停止监听加速度。 |
+| [onAccelerometerChange](#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startaccelerometer"></a>
+### startAccelerometer()
+
+> **startAccelerometer**(`params`?): `Promise`\<`object`\>
+
+开始监听加速度。
+
+#### Parameters
+
+• **params?**: [`StartAccelerometerParams`](#startaccelerometerparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopAccelerometer。
+
+<a id="stopaccelerometer"></a>
+### stopAccelerometer()
+
+> **stopAccelerometer**(`params`?): `Promise`\<`object`\>
+
+停止监听加速度。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="onaccelerometerchange"></a>
+### onAccelerometerChange()
+
+> **onAccelerometerChange**(`handler`): () => `void`
+
+监听加速度数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onAccelerometerChange } from '@doubao-apps/framework/api';
+
+const off = onAccelerometerChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 相关类型
+
+<a id="startaccelerometerparams"></a>
+### StartAccelerometerParams
+
+开始监听加速度的请求参数。
+
+#### Properties
+
+##### interval?
+
+> `optional` **interval**: [`SensorInterval`](#sensorinterval)
+
+监听频率。
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+
+传感器监听频率。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/12-/350/256/276/345/244/207-ibeacon.md

@@ -0,0 +1,148 @@
+# Open API: 设备 / iBeacon
+
+iBeacon 搜索和结果读取能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startBeaconDiscovery](#startbeacondiscovery) | 开始搜索附近的 iBeacon。<br><br>需配对调用 stopBeaconDiscovery。 |
+| [stopBeaconDiscovery](#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
+| [getBeacons](#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
+
+## API 详情
+
+<a id="startbeacondiscovery"></a>
+### startBeaconDiscovery()
+
+> **startBeaconDiscovery**(`params`): `Promise`\<`object`\>
+
+开始搜索附近的 iBeacon。
+
+#### Parameters
+
+• **params**: [`StartBeaconDiscoveryParams`](#startbeacondiscoveryparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopBeaconDiscovery。
+
+<a id="stopbeacondiscovery"></a>
+### stopBeaconDiscovery()
+
+> **stopBeaconDiscovery**(`params`?): `Promise`\<`object`\>
+
+停止搜索附近的 iBeacon。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getbeacons"></a>
+### getBeacons()
+
+> **getBeacons**(`params`?): `Promise`\<[`GetBeaconsResult`](#getbeaconsresult)\>
+
+获取已搜索到的 iBeacon 列表。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBeaconsResult`](#getbeaconsresult)\>
+
+## 相关类型
+
+<a id="startbeacondiscoveryparams"></a>
+### StartBeaconDiscoveryParams
+
+开始搜索 iBeacon 的请求参数。
+
+#### Properties
+
+##### ignoreBluetoothAvailable?
+
+> `optional` **ignoreBluetoothAvailable**: `boolean`
+
+iOS 下是否忽略蓝牙可用性校验。
+
+##### uuids
+
+> **uuids**: `string`[]
+
+要搜索的 iBeacon UUID 列表。
+
+<a id="getbeaconsresult"></a>
+### GetBeaconsResult
+
+获取 iBeacon 列表的返回结果。
+
+#### Properties
+
+##### beacons
+
+> **beacons**: [`BeaconInfo`](#beaconinfo)[]
+
+当前搜到的 iBeacon 列表。
+
+<a id="beaconinfo"></a>
+### BeaconInfo
+
+iBeacon 设备信息。
+
+#### Properties
+
+##### accuracy
+
+> **accuracy**: `number`
+
+距离，单位米。
+
+##### major
+
+> **major**: `string`
+
+主 ID。
+
+##### minor
+
+> **minor**: `string`
+
+次 ID。
+
+##### proximity
+
+> **proximity**: [`BeaconProximity`](#beaconproximity)
+
+距离等级。
+
+##### rssi
+
+> **rssi**: `number`
+
+RSSI 信号强度，单位 dBm。
+
+##### uuid
+
+> **uuid**: `string`
+
+Beacon UUID。
+
+<a id="beaconproximity"></a>
+### BeaconProximity
+
+> **BeaconProximity**: `0` \| `1` \| `2` \| `3`
+
+iBeacon 距离等级。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/13-/350/256/276/345/244/207-/347/275/227/347/233/230.md

@@ -0,0 +1,82 @@
+# Open API: 设备 / 罗盘
+
+罗盘监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startCompass](#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
+| [stopCompass](#stopcompass) | 停止监听罗盘。 |
+| [onCompassChange](#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startcompass"></a>
+### startCompass()
+
+> **startCompass**(`params`?): `Promise`\<`object`\>
+
+开始监听罗盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopCompass。
+
+<a id="stopcompass"></a>
+### stopCompass()
+
+> **stopCompass**(`params`?): `Promise`\<`object`\>
+
+停止监听罗盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="oncompasschange"></a>
+### onCompassChange()
+
+> **onCompassChange**(`handler`): () => `void`
+
+监听罗盘数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onCompassChange } from '@doubao-apps/framework/api';
+
+const off = onCompassChange(({ direction }) => {
+  console.log(direction);
+});
+
+off();
+```

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/14-/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -0,0 +1,70 @@
+# Open API: 设备 / 设备方向
+
+设备方向监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
+| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+
+## API 详情
+
+<a id="startdevicemotionlistening"></a>
+### startDeviceMotionListening()
+
+> **startDeviceMotionListening**(`params`?): `Promise`\<`object`\>
+
+开始监听设备方向变化。
+
+#### Parameters
+
+• **params?**: [`StartDeviceMotionListeningParams`](#startdevicemotionlisteningparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopDeviceMotionListening。
+
+<a id="stopdevicemotionlistening"></a>
+### stopDeviceMotionListening()
+
+> **stopDeviceMotionListening**(`params`?): `Promise`\<`object`\>
+
+停止监听设备方向变化。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="startdevicemotionlisteningparams"></a>
+### StartDeviceMotionListeningParams
+
+开始监听设备方向变化的请求参数。
+
+#### Properties
+
+##### interval?
+
+> `optional` **interval**: [`SensorInterval`](#sensorinterval)
+
+监听频率。
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+
+传感器监听频率。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/15-/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md

@@ -0,0 +1,104 @@
+# Open API: 设备 / 陀螺仪
+
+陀螺仪监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。<br><br>需配对调用 stopGyroscope。 |
+| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
+| [onGyroscopeChange](#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startgyroscope"></a>
+### startGyroscope()
+
+> **startGyroscope**(`params`?): `Promise`\<`object`\>
+
+开始监听陀螺仪。
+
+#### Parameters
+
+• **params?**: [`StartGyroscopeParams`](#startgyroscopeparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopGyroscope。
+
+<a id="stopgyroscope"></a>
+### stopGyroscope()
+
+> **stopGyroscope**(`params`?): `Promise`\<`object`\>
+
+停止监听陀螺仪。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="ongyroscopechange"></a>
+### onGyroscopeChange()
+
+> **onGyroscopeChange**(`handler`): () => `void`
+
+监听陀螺仪数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onGyroscopeChange } from '@doubao-apps/framework/api';
+
+const off = onGyroscopeChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 相关类型
+
+<a id="startgyroscopeparams"></a>
+### StartGyroscopeParams
+
+开始监听陀螺仪的请求参数。
+
+#### Properties
+
+##### interval?
+
+> `optional` **interval**: [`SensorInterval`](#sensorinterval)
+
+监听频率。
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+
+传感器监听频率。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/16-ui-/350/276/223/345/205/245.md

@@ -0,0 +1,65 @@
+# Open API: UI / 输入
+
+键盘和输入框选区能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [hideKeyboard](#hidekeyboard) | 收起键盘。 |
+| [getSelectedTextRange](#getselectedtextrange) | 获取当前输入框的选区范围。 |
+
+## API 详情
+
+<a id="hidekeyboard"></a>
+### hideKeyboard()
+
+> **hideKeyboard**(`params`?): `Promise`\<`object`\>
+
+收起键盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getselectedtextrange"></a>
+### getSelectedTextRange()
+
+> **getSelectedTextRange**(`params`?): `Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
+
+获取当前输入框的选区范围。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
+
+## 相关类型
+
+<a id="getselectedtextrangeresult"></a>
+### GetSelectedTextRangeResult
+
+获取输入框选区范围的返回结果。
+
+#### Properties
+
+##### end
+
+> **end**: `number`
+
+选区结束位置。
+
+##### start
+
+> **start**: `number`
+
+选区起始位置。