@doubao-apps/ai 0.0.26 → 0.0.27

package/dist/skills/doubao-apps-dev/.ai/reference/open-api/06-network.md

@@ -1,298 +0,0 @@
-# Open API: Network
-
-网络请求、网络类型和本机局域网 IP。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`request`](#request) | `request(params): Promise<RequestResponse>` | 发起网络请求 | `params: RequestParams` | `Promise<RequestResponse>` | 返回 statusCode、header 和 data |
-| [`getNetworkType`](#getnetworktype) | `getNetworkType(params?): Promise<GetNetworkTypeResult>` | 获取当前网络类型 | `params?: GetNetworkTypeParams` | `Promise<GetNetworkTypeResult>` | - |
-| [`onNetworkStatusChange`](#onnetworkstatuschange) | `onNetworkStatusChange(handler): () => void` | 监听网络状态变化事件 | `handler` | `() => void` | 返回取消监听函数 |
-| [`getLocalIPAddress`](#getlocalipaddress) | `getLocalIPAddress(params?): Promise<GetLocalIPAddressResult>` | 获取局域网 IP 地址 | `params?` | `Promise<GetLocalIPAddressResult>` | - |
-
-## API 详情
-
-<a id="request"></a>
-### request()
-
-> **request**(`params`): `Promise`\<[`RequestResponse`](#requestresponse)\>
-
-发起网络请求。
-
-#### Parameters
-
-• **params**: [`RequestParams`](#requestparams)
-
-请求参数，字段见 [RequestParams](#requestparams)。
-
-#### Returns
-
-`Promise`\<[`RequestResponse`](#requestresponse)\>
-
-返回一个 Promise，解析为 [RequestResponse](#requestresponse)。
-
-#### Remarks
-
-返回 statusCode、header 和 data。
-
-#### Example
-
-```typescript
-import { request } from '@doubao-apps/framework/api';
-
-const result = await request({
-  url: 'https://postman-echo.com/post',
-  method: 'POST',
-  dataType: 'json',
-  header: { 'content-type': 'application/json' },
-  data: { hello: 'world' }
-});
-
-console.log(result.statusCode, result.data);
-```
-
-<a id="getnetworktype"></a>
-### getNetworkType()
-
-> **getNetworkType**(`params`?): `Promise`\<[`GetNetworkTypeResult`](#getnetworktyperesult)\>
-
-获取当前网络类型。
-
-#### Parameters
-
-• **params?**: [`GetNetworkTypeParams`](#getnetworktypeparams)
-
-#### Returns
-
-`Promise`\<[`GetNetworkTypeResult`](#getnetworktyperesult)\>
-
-返回一个 Promise，解析为 [GetNetworkTypeResult](#getnetworktyperesult)。
-
-#### Example
-
-```ts
-import { getNetworkType } from '@byted-doubao-apps/framework/api';
-
-const result = await getNetworkType();
-console.log(result.networkType);
-```
-
-<a id="onnetworkstatuschange"></a>
-### onNetworkStatusChange()
-
-> **onNetworkStatusChange**(`handler`): () => `void`
-
-监听网络状态变化事件。
-
-#### Parameters
-
-• **handler**
-
-#### Returns
-
-`Function`
-
-返回取消当前监听函数的函数。
-
-##### Returns
-
-`void`
-
-#### Example
-
-```ts
-import { onNetworkStatusChange } from '@byted-doubao-apps/framework/api';
-
-const off = onNetworkStatusChange(({ isConnected, networkType }) => {
-  console.log(isConnected, networkType);
-});
-
-off();
-```
-
-<a id="getlocalipaddress"></a>
-### getLocalIPAddress()
-
-> **getLocalIPAddress**(`params`?): `Promise`\<[`GetLocalIPAddressResult`](#getlocalipaddressresult)\>
-
-获取局域网 IP 地址。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<[`GetLocalIPAddressResult`](#getlocalipaddressresult)\>
-
-## 相关类型
-
-<a id="requestparams"></a>
-### RequestParams
-
-网络请求参数。
-
-#### Properties
-
-##### data?
-
-> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
-
-请求体数据。
-
-传给服务器的数据最终会是 `String` 或 `ArrayBuffer`：
-- 若 `data` 是 `string` 或 `ArrayBuffer`，直接使用；
-- 若 `header['content-type']` 是 `application/x-www-form-urlencoded`，会被编码为 query string，例如：`encodeURIComponent(k)=encodeURIComponent(v)`；
-- 若 `header['content-type']` 是 `application/json`，会执行 JSON 序列化；
-- 若 `data` 是普通对象且未命中上述类型，也会执行 JSON 序列化；
-- 其他类型会调用 `toString()`
-
-##### dataType?
-
-> `optional` **dataType**: `"string"` \| `"json"`
-
-期望返回的数据格式。
-- `json`: 尝试按 JSON 解析；
-- `string`: 按字符串返回。
-
-###### Default
-
-```ts
-"json"
-```
-
-##### header?
-
-> `optional` **header**: `Record`\<`string`, `string`\>
-
-请求 Header。
-
-###### Default
-
-```ts
-{"content-type": "application/json"}
-```
-
-##### method?
-
-> `optional` **method**: [`RequestMethod`](#requestmethod)
-
-请求方法。
-
-###### Default
-
-```ts
-"GET"
-```
-
-##### url
-
-> **url**: `string`
-
-请求地址，需为完整的 **HTTPS** URL。
-
-<a id="requestresponse"></a>
-### RequestResponse
-
-网络请求返回结果。
-
-#### Properties
-
-##### data?
-
-> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
-
-响应数据，类型由 `dataType` 决定。
-
-##### header
-
-> **header**: `Record`\<`string`, `string`\>
-
-HTTP 响应头。
-
-##### statusCode
-
-> **statusCode**: `number`
-
-HTTP 状态码。
-
-<a id="requestmethod"></a>
-### RequestMethod
-
-> **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
-
-<a id="getnetworktypeparams"></a>
-### GetNetworkTypeParams
-
-获取网络类型的请求参数。
-
-当前无需传入任何字段，预留扩展位。
-
-<a id="getnetworktyperesult"></a>
-### GetNetworkTypeResult
-
-获取网络类型的返回结果。
-
-#### Properties
-
-##### hasSystemProxy?
-
-> `optional` **hasSystemProxy**: `boolean`
-
-设备是否使用了系统代理。
-
-##### networkType
-
-> **networkType**: [`NetworkType`](#networktype-2)
-
-当前网络类型。
-
-##### signalStrength?
-
-> `optional` **signalStrength**: `number`
-
-信号强弱，单位 dBm。
-
-##### weakNet?
-
-> `optional` **weakNet**: `boolean`
-
-是否处于弱网环境。
-
-<a id="networktype-2"></a>
-<a id="networktype"></a>
-### NetworkType
-
-> **NetworkType**: `"wifi"` \| `"2g"` \| `"3g"` \| `"4g"` \| `"5g"` \| `"unknown"` \| `"none"`
-
-网络类型。
-
-- `wifi` - Wi-Fi 网络
-- `2g` - 2G 网络
-- `3g` - 3G 网络
-- `4g` - 4G 网络
-- `5g` - 5G 网络
-- `unknown` - Android 下不常见的网络类型
-- `none` - 无网络
-
-<a id="getlocalipaddressresult"></a>
-### GetLocalIPAddressResult
-
-获取局域网 IP 的返回结果。
-
-#### Properties
-
-##### localIp
-
-> **localIp**: `string`
-
-本机局域网 IP 地址。
-
-##### netmask?
-
-> `optional` **netmask**: `string`
-
-子网掩码。

package/dist/skills/doubao-apps-dev/.ai/reference/open-api/11-device-/344/274/240/346/204/237/345/231/250.md

@@ -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)
-
-监听频率。