npm - @doubao-apps/create - Versions diffs - 0.0.26 → 0.0.27 - Mend

@doubao-apps/create 0.0.26 → 0.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (99) hide show

package/dist/template-empty/.ai/reference/open-api/11-device-/344/274/240/346/204/237/345/231/250.md DELETED Viewed

@@ -1,372 +0,0 @@
-# Open API: Device / 传感器
-加速度、罗盘、陀螺仪、设备方向和 iBeacon。
-[返回目录](./README.md) | [返回速查](../open-api.md)
-## 速查
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`startAccelerometer`](#startaccelerometer) | `startAccelerometer(params?): Promise<object>` | 开始监听加速度 | `params?: StartAccelerometerParams` | `Promise<object>` | 需配对调用 stopAccelerometer |
-| [`stopAccelerometer`](#stopaccelerometer) | `stopAccelerometer(params?): Promise<object>` | 停止监听加速度 | `params?` | `Promise<object>` | - |
-| [`startBeaconDiscovery`](#startbeacondiscovery) | `startBeaconDiscovery(params): Promise<object>` | 开始搜索附近的 iBeacon | `params: StartBeaconDiscoveryParams` | `Promise<object>` | 需配对调用 stopBeaconDiscovery |
-| [`stopBeaconDiscovery`](#stopbeacondiscovery) | `stopBeaconDiscovery(params?): Promise<object>` | 停止搜索附近的 iBeacon | `params?` | `Promise<object>` | - |
-| [`getBeacons`](#getbeacons) | `getBeacons(params?): Promise<GetBeaconsResult>` | 获取已搜索到的 iBeacon 列表 | `params?` | `Promise<GetBeaconsResult>` | - |
-| [`startCompass`](#startcompass) | `startCompass(params?): Promise<object>` | 开始监听罗盘 | `params?` | `Promise<object>` | 需配对调用 stopCompass |
-| [`stopCompass`](#stopcompass) | `stopCompass(params?): Promise<object>` | 停止监听罗盘 | `params?` | `Promise<object>` | - |
-| [`onCompassChange`](#oncompasschange) | `onCompassChange(handler): () => void` | 监听罗盘数据变化事件 | `handler` | `() => void` | 返回取消监听函数 |
-| [`startDeviceMotionListening`](#startdevicemotionlistening) | `startDeviceMotionListening(params?): Promise<object>` | 开始监听设备方向变化 | `params?: StartDeviceMotionListeningParams` | `Promise<object>` | 需配对调用 stopDeviceMotionListening |
-| [`stopDeviceMotionListening`](#stopdevicemotionlistening) | `stopDeviceMotionListening(params?): Promise<object>` | 停止监听设备方向变化 | `params?` | `Promise<object>` | - |
-| [`startGyroscope`](#startgyroscope) | `startGyroscope(params?): Promise<object>` | 开始监听陀螺仪 | `params?: StartGyroscopeParams` | `Promise<object>` | 需配对调用 stopGyroscope |
-| [`stopGyroscope`](#stopgyroscope) | `stopGyroscope(params?): Promise<object>` | 停止监听陀螺仪 | `params?` | `Promise<object>` | - |
-## 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="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="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();
-```
-<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="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="startaccelerometerparams"></a>
-### StartAccelerometerParams
-开始监听加速度的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](#sensorinterval)
-监听频率。
-<a id="sensorinterval"></a>
-### SensorInterval
-> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
-传感器监听频率。
-<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 距离等级。
-<a id="startdevicemotionlisteningparams"></a>
-### StartDeviceMotionListeningParams
-开始监听设备方向变化的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](#sensorinterval)
-监听频率。
-<a id="startgyroscopeparams"></a>
-### StartGyroscopeParams
-开始监听陀螺仪的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](#sensorinterval)
-监听频率。