@doubao-apps/create 0.0.25 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/10-/350/256/276/345/244/207-wi-fi.md

@@ -0,0 +1,277 @@
+# Open API: 设备 / Wi-Fi
+
+Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startWifi](#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
+| [stopWifi](#stopwifi) | 关闭 Wi-Fi 模块。 |
+| [setWifiList](#setwifilist) | 设置 Wi-Fi 预设列表。<br><br>用于预设 Wi-Fi 列表。 |
+| [connectWifi](#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi。 |
+| [getConnectedWifi](#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
+| [getWifiList](#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi。 |
+
+## API 详情
+
+<a id="startwifi"></a>
+### startWifi()
+
+> **startWifi**(`params`?): `Promise`\<`object`\>
+
+初始化 Wi-Fi 模块。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+Wi-Fi 流程入口。
+
+<a id="stopwifi"></a>
+### stopWifi()
+
+> **stopWifi**(`params`?): `Promise`\<`object`\>
+
+关闭 Wi-Fi 模块。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="setwifilist"></a>
+### setWifiList()
+
+> **setWifiList**(`params`): `Promise`\<`object`\>
+
+设置 Wi-Fi 预设列表。
+
+#### Parameters
+
+• **params**: [`SetWifiListParams`](#setwifilistparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+用于预设 Wi-Fi 列表。
+
+<a id="connectwifi"></a>
+### connectWifi()
+
+> **connectWifi**(`params`): `Promise`\<`object`\>
+
+连接指定 Wi-Fi。
+
+#### Parameters
+
+• **params**: [`ConnectWifiParams`](#connectwifiparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+通常先调用 startWifi。
+
+<a id="getconnectedwifi"></a>
+### getConnectedWifi()
+
+> **getConnectedWifi**(`params`?): `Promise`\<[`GetConnectedWifiResult`](#getconnectedwifiresult)\>
+
+获取当前已连接 Wi-Fi 信息。
+
+#### Parameters
+
+• **params?**: [`GetConnectedWifiParams`](#getconnectedwifiparams)
+
+#### Returns
+
+`Promise`\<[`GetConnectedWifiResult`](#getconnectedwifiresult)\>
+
+<a id="getwifilist"></a>
+### getWifiList()
+
+> **getWifiList**(`params`?): `Promise`\<[`GetWifiListResult`](#getwifilistresult)\>
+
+获取 Wi-Fi 列表。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetWifiListResult`](#getwifilistresult)\>
+
+#### Remarks
+
+通常先调用 startWifi。
+
+## 相关类型
+
+<a id="setwifilistparams"></a>
+### SetWifiListParams
+
+设置 Wi-Fi 预设列表的请求参数。
+
+#### Properties
+
+##### wifiList
+
+> **wifiList**: [`WifiListItem`](#wifilistitem)[]
+
+预设的 Wi-Fi 列表。
+
+<a id="wifilistitem"></a>
+### WifiListItem
+
+预设 Wi-Fi 条目。
+
+#### Properties
+
+##### bssid?
+
+> `optional` **bssid**: `string`
+
+Wi-Fi BSSID。
+
+##### password?
+
+> `optional` **password**: `string`
+
+Wi-Fi 密码。
+
+##### ssid?
+
+> `optional` **ssid**: `string`
+
+Wi-Fi SSID。
+
+<a id="connectwifiparams"></a>
+### ConnectWifiParams
+
+连接 Wi-Fi 的请求参数。
+
+#### Properties
+
+##### bssid?
+
+> `optional` **bssid**: `string`
+
+Wi-Fi BSSID。
+
+##### manual?
+
+> `optional` **manual**: `boolean`
+
+是否跳转到系统设置页连接。
+
+##### partialInfo?
+
+> `optional` **partialInfo**: `boolean`
+
+是否仅返回部分 Wi-Fi 信息。
+
+##### password
+
+> **password**: `string`
+
+Wi-Fi 密码。
+
+##### ssid
+
+> **ssid**: `string`
+
+Wi-Fi SSID。
+
+<a id="getconnectedwifiparams"></a>
+### GetConnectedWifiParams
+
+获取当前已连接 Wi-Fi 的请求参数。
+
+#### Properties
+
+##### partialInfo?
+
+> `optional` **partialInfo**: `boolean`
+
+是否只返回部分 Wi-Fi 信息。
+
+<a id="getconnectedwifiresult"></a>
+### GetConnectedWifiResult
+
+获取当前已连接 Wi-Fi 的返回结果。
+
+#### Properties
+
+##### wifi
+
+> **wifi**: [`WifiInfo`](#wifiinfo)
+
+当前连接的 Wi-Fi 信息。
+
+<a id="wifiinfo"></a>
+### WifiInfo
+
+Wi-Fi 信息。
+
+#### Properties
+
+##### bssid?
+
+> `optional` **bssid**: `string`
+
+Wi-Fi BSSID。
+
+##### frequency?
+
+> `optional` **frequency**: `number`
+
+频段，单位 MHz。
+
+##### secure?
+
+> `optional` **secure**: `boolean`
+
+Wi-Fi 是否安全。
+
+##### signalStrength?
+
+> `optional` **signalStrength**: `number`
+
+信号强度。
+
+##### ssid
+
+> **ssid**: `string`
+
+Wi-Fi SSID。
+
+<a id="getwifilistresult"></a>
+### GetWifiListResult
+
+获取 Wi-Fi 列表的返回结果。
+
+#### Properties
+
+##### wifiList
+
+> **wifiList**: [`WifiInfo`](#wifiinfo)[]
+
+当前获取到的 Wi-Fi 列表。

package/dist/template-starter/.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/template-starter/.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/template-starter/.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/template-starter/.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"`
+
+传感器监听频率。