@doubao-dev/framework 0.0.40 → 0.0.41
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.
- package/dist/api.d.ts +539 -132
- package/dist/config.d.ts +4 -0
- package/dist/index.d.ts +4 -0
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -259,7 +259,24 @@ export declare type AppTheme = 'light' | 'dark';
|
|
|
259
259
|
* @authorizationBehavior All | 调用会主动向用户发起指定 scope 的授权弹窗。用户拒绝、取消或此前已撤销授权时调用直接失败,可再次调用 `authorize` 重新发起;scope 未在应用权限声明中配置或不受支持时也会失败。
|
|
260
260
|
* @precondition All | 在应用权限声明中配置需要申请的 scope。
|
|
261
261
|
* @usageNote All | 授权状态可通过 `getSetting` 查询;建议在真正需要能力前再发起授权。
|
|
262
|
-
* @
|
|
262
|
+
* @errorExample
|
|
263
|
+
* ```json
|
|
264
|
+
* {
|
|
265
|
+
* "errNo": 107,
|
|
266
|
+
* "errMsg": "user permission denied"
|
|
267
|
+
* }
|
|
268
|
+
* ```
|
|
269
|
+
* @errorCode common | 102 | Android,iOS
|
|
270
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | 传入的 scope 为空或不受支持(如 scope.payment) | 检查并传入受支持的 scope 后重试。
|
|
271
|
+
* @errorCode errNo | 106 | system permission denied | Android,iOS | 对应能力的系统权限被拒绝 | 引导用户在系统设置中开启对应权限后重试。
|
|
272
|
+
* @errorCode errNo | 107 | user permission denied | Android,iOS | 用户拒绝了本次应用授权 | 说明能力用途后再次调用 `authorize` 重新发起授权。
|
|
273
|
+
* @errorCode errNo | 114 | operation cancelled | Android,iOS | 用户取消了授权弹窗 | 用户需要时可再次调用 `authorize` 重新发起授权。
|
|
274
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | 授权过程中的网络请求被取消 | 确认应用和网络状态后重试。
|
|
275
|
+
* @errorCode errNo | 302 | connection timed out | iOS | 授权过程中的网络连接超时 | 检查网络连接后重试。
|
|
276
|
+
* @errorCode errNo | 303 | no network connection | iOS | 当前无可用网络连接 | 恢复网络连接后重试。
|
|
277
|
+
* @errorCode errNo | 305 | network failure | Android,iOS | 授权过程中发生其他网络错误 | 检查网络连接,稍后重试。
|
|
278
|
+
* @errorCode errNo | 112 | invalid result | iOS | 授权服务返回的数据无法解析 | 稍后重试;持续失败时反馈服务端响应异常。
|
|
279
|
+
* @platformNote iOS | 网络类失败会细分为 301/302/303/305,并可能返回 112;Android 的网络类失败统一返回 305。
|
|
263
280
|
*
|
|
264
281
|
* @public
|
|
265
282
|
*/
|
|
@@ -763,7 +780,15 @@ export declare interface CanIUseResult {
|
|
|
763
780
|
* "open": false
|
|
764
781
|
* }
|
|
765
782
|
* ```
|
|
766
|
-
* @
|
|
783
|
+
* @errorExample
|
|
784
|
+
* ```json
|
|
785
|
+
* {
|
|
786
|
+
* "errNo": 103,
|
|
787
|
+
* "errMsg": "feature not support"
|
|
788
|
+
* }
|
|
789
|
+
* ```
|
|
790
|
+
* @errorCode common | 102 | Android
|
|
791
|
+
* @errorCode errNo | 103 | feature not support | Android | 当前运行环境无法获取系统无障碍服务 | 在具备系统无障碍服务的设备上调用。
|
|
767
792
|
*
|
|
768
793
|
* @public
|
|
769
794
|
*/
|
|
@@ -1378,7 +1403,23 @@ export declare interface ConnectedBluetoothDevice {
|
|
|
1378
1403
|
* "readyState": 0
|
|
1379
1404
|
* }
|
|
1380
1405
|
* ```
|
|
1381
|
-
* @
|
|
1406
|
+
* @errorExample
|
|
1407
|
+
* ```json
|
|
1408
|
+
* {
|
|
1409
|
+
* "errNo": 1501001,
|
|
1410
|
+
* "errMsg": "websocket connection limit exceeded"
|
|
1411
|
+
* }
|
|
1412
|
+
* ```
|
|
1413
|
+
* @errorCode common | 102 | Android
|
|
1414
|
+
* @errorCode common | 113 | Android,iOS
|
|
1415
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | 创建连接时 url 为空或非 ws/wss,或调用 send 时 base64 数据非法、dataType 不支持 | 传入合法的 ws/wss url 与受支持的发送数据后重试。
|
|
1416
|
+
* @errorCode errNo | 110 | API call prohibited | Android,iOS | socket url 未通过域名白名单校验 | 确认目标域名已在智能服务中配置后重试。
|
|
1417
|
+
* @errorCode errNo | 116 | resource not found | Android,iOS | 对已关闭或不存在的 socketTaskId 调用 send/close | 仅在 onOpen 后、onClose 前操作连接,不要复用已关闭的连接。
|
|
1418
|
+
* @errorCode errNo | 305 | network failure | Android,iOS | 建立连接、发送或关闭过程中发生网络错误 | 检查网络连接,必要时重新建立连接。
|
|
1419
|
+
* @errorCode errNo | 1501001 | websocket connection limit exceeded | Android,iOS | 同一智能服务的 WebSocket 连接数超过上限 | 关闭不再使用的连接后重试。
|
|
1420
|
+
* @errorCode errNo | 1501002 | websocket is not open | iOS | 连接尚未打开或已关闭时调用 send | 在收到 onOpen 事件后再发送数据。
|
|
1421
|
+
* @platformNote Android | 建立连接失败统一返回 102;send 在连接未打开时返回 305 或 116。
|
|
1422
|
+
* @platformNote iOS | send 在连接未打开时返回 1501002。
|
|
1382
1423
|
*
|
|
1383
1424
|
* @public
|
|
1384
1425
|
*/
|
|
@@ -1459,7 +1500,20 @@ export declare interface ConnectSocketParams {
|
|
|
1459
1500
|
* ```json
|
|
1460
1501
|
* {}
|
|
1461
1502
|
* ```
|
|
1462
|
-
* @
|
|
1503
|
+
* @errorExample
|
|
1504
|
+
* ```json
|
|
1505
|
+
* {
|
|
1506
|
+
* "errNo": 1401003,
|
|
1507
|
+
* "errMsg": "connect wifi failed"
|
|
1508
|
+
* }
|
|
1509
|
+
* ```
|
|
1510
|
+
* @errorCode common | 102 | Android,iOS
|
|
1511
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | ssid 为空 | 传入非空的 ssid 后重试
|
|
1512
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 设备无可用的 Wi-Fi 能力,或 iOS 系统版本过低不支持连接 | 检查设备与系统能力,不支持时不要调用
|
|
1513
|
+
* @errorCode errNo | 1401001 | wifi is not initialized | Android,iOS | 调用前未先调用 startWifi 完成初始化 | 先调用 startWifi 再连接 Wi-Fi
|
|
1514
|
+
* @errorCode errNo | 115 | operation timeout | Android | 连接 Wi-Fi 超时 | 确认目标网络可用后提示用户重试
|
|
1515
|
+
* @errorCode errNo | 1401003 | connect wifi failed | Android,iOS | 连接目标 Wi-Fi 失败(如密码错误、网络不可达、系统连接被拒) | 检查 ssid 与密码后提示用户重试
|
|
1516
|
+
* @platformNote Android | 连接超时返回 115;iOS 未细分超时,连接失败统一归为 1401003。
|
|
1463
1517
|
*
|
|
1464
1518
|
* @public
|
|
1465
1519
|
*/
|
|
@@ -1516,6 +1570,22 @@ export declare type Content = {
|
|
|
1516
1570
|
/** API 调用参数。 */
|
|
1517
1571
|
arguments: object;
|
|
1518
1572
|
};
|
|
1573
|
+
} | {
|
|
1574
|
+
/** 模型响应提示。 */
|
|
1575
|
+
type: 'responseHint';
|
|
1576
|
+
/** 用户动作和模型响应建议。 */
|
|
1577
|
+
data: {
|
|
1578
|
+
/**
|
|
1579
|
+
* 用户做了什么。
|
|
1580
|
+
* @default -
|
|
1581
|
+
*/
|
|
1582
|
+
userAction?: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* 建议模型如何响应。
|
|
1585
|
+
* @default -
|
|
1586
|
+
*/
|
|
1587
|
+
responseGuidance?: string;
|
|
1588
|
+
};
|
|
1519
1589
|
};
|
|
1520
1590
|
|
|
1521
1591
|
/**
|
|
@@ -1726,7 +1796,7 @@ export declare function createInnerAudioContext(): InnerAudioContext;
|
|
|
1726
1796
|
* "logId": "20260519xxxx"
|
|
1727
1797
|
* }
|
|
1728
1798
|
* ```
|
|
1729
|
-
* @errorCode
|
|
1799
|
+
* @errorCode common | 102 | Android,iOS
|
|
1730
1800
|
* @knownIssue All | 失败结果不会作为 await 的返回值,需通过 catch 捕获并从错误对象的 data 字段读取 errNo、errMsg、errLogId。
|
|
1731
1801
|
*
|
|
1732
1802
|
* @public
|
|
@@ -1822,7 +1892,17 @@ export declare interface CreateSignOrderSuccessResult {
|
|
|
1822
1892
|
* "expiresIn": 3600
|
|
1823
1893
|
* }
|
|
1824
1894
|
* ```
|
|
1825
|
-
* @
|
|
1895
|
+
* @errorExample
|
|
1896
|
+
* ```json
|
|
1897
|
+
* {
|
|
1898
|
+
* "errNo": 104,
|
|
1899
|
+
* "errMsg": "invalid parameter"
|
|
1900
|
+
* }
|
|
1901
|
+
* ```
|
|
1902
|
+
* @errorCode common | 102 | Android,iOS
|
|
1903
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | taskType 不是 remote(如传入 local) | 传入 remote 任务类型后重试。
|
|
1904
|
+
* @errorCode errNo | 112 | invalid result | Android,iOS | 远端任务创建成功但返回数据为空或缺少 taskId | 稍后重试;持续失败时反馈服务端响应异常。
|
|
1905
|
+
* @platformNote All | taskType 非 remote 返回 104;远端返回数据为空或缺少 taskId 返回 112;其他失败统一返回 102。
|
|
1826
1906
|
*
|
|
1827
1907
|
* @public
|
|
1828
1908
|
*/
|
|
@@ -1943,7 +2023,7 @@ export declare type DeviceOrientation = 'portrait' | 'landscape';
|
|
|
1943
2023
|
* ```json
|
|
1944
2024
|
* {}
|
|
1945
2025
|
* ```
|
|
1946
|
-
* @errorCode
|
|
2026
|
+
* @errorCode common | 102 | Android,iOS
|
|
1947
2027
|
*
|
|
1948
2028
|
* @public
|
|
1949
2029
|
*/
|
|
@@ -1954,6 +2034,7 @@ export declare const disableUserScreenRecord: (params?: {} | undefined) => Promi
|
|
|
1954
2034
|
*
|
|
1955
2035
|
* @param params - 动作描述、预期行为及工具调用约束参数。
|
|
1956
2036
|
* @returns 返回一个 Promise,在动作指令成功下发时解析。
|
|
2037
|
+
* @deprecated 使用 {@link sendFollowUpMessage} 发送后续消息。
|
|
1957
2038
|
* @remarks
|
|
1958
2039
|
* 适用于卡片交互后向模型补充结构化动作上下文,例如按钮点击、选项选择或表单提交。
|
|
1959
2040
|
* `getWidgetInstanceId` 仅在卡片环境中有效,在智能服务页面中会返回 `undefined`。如果需要在页面中调用,
|
|
@@ -1983,9 +2064,18 @@ export declare const disableUserScreenRecord: (params?: {} | undefined) => Promi
|
|
|
1983
2064
|
* @precondition Android | 在卡片或会话环境中调用,需传入有效的 widgetInstanceId。
|
|
1984
2065
|
* @precondition iOS | 在卡片或会话环境中调用,需传入有效的 widgetInstanceId。
|
|
1985
2066
|
* @usageNote All | 请在卡片交互(按钮点击、选项选择、表单提交)后调用,向模型补充结构化动作上下文。
|
|
1986
|
-
* @
|
|
2067
|
+
* @errorExample
|
|
2068
|
+
* ```json
|
|
2069
|
+
* {
|
|
2070
|
+
* "errNo": 116,
|
|
2071
|
+
* "errMsg": "resource not found"
|
|
2072
|
+
* }
|
|
2073
|
+
* ```
|
|
2074
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前运行环境未接入消息下发能力(宿主消息依赖或消息服务缺失) | 请在支持消息下发的豆包环境中调用。
|
|
2075
|
+
* @errorCode errNo | 116 | resource not found | Android,iOS | 依据 widgetInstanceId 找不到对应会话 | 确认 widgetInstanceId 有效且处于会话环境后重试。
|
|
2076
|
+
* @platformNote All | 找不到会话返回 116;宿主消息依赖或消息服务缺失返回 103。
|
|
1987
2077
|
*
|
|
1988
|
-
* @
|
|
2078
|
+
* @internal
|
|
1989
2079
|
*/
|
|
1990
2080
|
export declare const dispatchActionDirective: (params: DispatchActionDirectiveParams) => Promise<object>;
|
|
1991
2081
|
|
|
@@ -2238,7 +2328,7 @@ export declare interface DownloadTaskHeadersReceivedEvent {
|
|
|
2238
2328
|
* ```json
|
|
2239
2329
|
* {}
|
|
2240
2330
|
* ```
|
|
2241
|
-
* @errorCode
|
|
2331
|
+
* @errorCode common | 102 | Android,iOS
|
|
2242
2332
|
*
|
|
2243
2333
|
* @public
|
|
2244
2334
|
*/
|
|
@@ -2264,7 +2354,7 @@ export declare const enableUserScreenRecord: (params?: {} | undefined) => Promis
|
|
|
2264
2354
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
2265
2355
|
* @precondition All | 无额外前置条件
|
|
2266
2356
|
* @usageNote All | 会退出当前所有页面;当 navigateBack 已无法继续返回时,使用 exitApp 退出智能服务。
|
|
2267
|
-
* @errorCode
|
|
2357
|
+
* @errorCode common | 102 | Android,iOS
|
|
2268
2358
|
*
|
|
2269
2359
|
* @public
|
|
2270
2360
|
*/
|
|
@@ -2455,7 +2545,7 @@ export declare interface FileSystemManager {
|
|
|
2455
2545
|
* }
|
|
2456
2546
|
* }
|
|
2457
2547
|
* ```
|
|
2458
|
-
* @errorCode
|
|
2548
|
+
* @errorCode common | 102 | Android
|
|
2459
2549
|
*
|
|
2460
2550
|
* @public
|
|
2461
2551
|
*/
|
|
@@ -2504,7 +2594,7 @@ export declare interface GetAccountInfoResult {
|
|
|
2504
2594
|
* }
|
|
2505
2595
|
* }
|
|
2506
2596
|
* ```
|
|
2507
|
-
* @errorCode
|
|
2597
|
+
* @errorCode common | 102 | Android
|
|
2508
2598
|
*
|
|
2509
2599
|
* @public
|
|
2510
2600
|
*/
|
|
@@ -2534,7 +2624,7 @@ export declare function getAccountInfoSync(params?: {}): GetAccountInfoResult;
|
|
|
2534
2624
|
* @platformSupport HarmonyOS | unsupported | 当前未提供该平台实现。
|
|
2535
2625
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
2536
2626
|
* @precondition All | 无额外前置条件
|
|
2537
|
-
* @usageNote All |
|
|
2627
|
+
* @usageNote All | 本接口查询宿主应用权限,不等同于查询当前智能服务 scope 授权。
|
|
2538
2628
|
* @usageNote iOS | SDK 首次完成通知设置异步预热前,或应用重新激活后的刷新尚未完成时,四个通知字段可能仍为旧值或 not determined。
|
|
2539
2629
|
* @resultExample
|
|
2540
2630
|
* ```json
|
|
@@ -2774,7 +2864,7 @@ export declare function getBackgroundAudioManager(): BackgroundAudioManager;
|
|
|
2774
2864
|
* "level": 82
|
|
2775
2865
|
* }
|
|
2776
2866
|
* ```
|
|
2777
|
-
* @errorCode
|
|
2867
|
+
* @errorCode common | 102 | Android
|
|
2778
2868
|
*
|
|
2779
2869
|
* @public
|
|
2780
2870
|
*/
|
|
@@ -3245,7 +3335,15 @@ export declare interface GetBluetoothDevicesResult {
|
|
|
3245
3335
|
* "data": "hello doubao"
|
|
3246
3336
|
* }
|
|
3247
3337
|
* ```
|
|
3248
|
-
* @
|
|
3338
|
+
* @errorExample
|
|
3339
|
+
* ```json
|
|
3340
|
+
* {
|
|
3341
|
+
* "errNo": 103,
|
|
3342
|
+
* "errMsg": "feature not support"
|
|
3343
|
+
* }
|
|
3344
|
+
* ```
|
|
3345
|
+
* @errorCode common | 102 | Android,iOS
|
|
3346
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前豆包版本或运行环境未提供剪贴板读取能力 | 在支持剪贴板能力的豆包版本中调用。
|
|
3249
3347
|
*
|
|
3250
3348
|
* @public
|
|
3251
3349
|
*/
|
|
@@ -3362,7 +3460,26 @@ export declare interface GetConnectedBluetoothDevicesResult {
|
|
|
3362
3460
|
* }
|
|
3363
3461
|
* }
|
|
3364
3462
|
* ```
|
|
3365
|
-
* @
|
|
3463
|
+
* @errorExample
|
|
3464
|
+
* ```json
|
|
3465
|
+
* {
|
|
3466
|
+
* "errNo": 1401002,
|
|
3467
|
+
* "errMsg": "wifi is not connected"
|
|
3468
|
+
* }
|
|
3469
|
+
* ```
|
|
3470
|
+
* @errorCode common | 102 | Android,iOS
|
|
3471
|
+
* @errorCode errNo | 1401001 | wifi is not initialized | Android,iOS | 调用前未先调用 startWifi 完成初始化 | 先调用 startWifi 再获取已连接 Wi-Fi
|
|
3472
|
+
* @errorCode errNo | 1401002 | wifi is not connected | Android,iOS | 当前未连接 Wi-Fi 或无法读取已连接 Wi-Fi 信息 | 确认设备已连接 Wi-Fi 后重试
|
|
3473
|
+
* @errorCode errNo | 106 | system permission denied | iOS | 系统定位服务未开启,无法读取 Wi-Fi 信息 | 引导用户在系统设置中开启定位服务
|
|
3474
|
+
* @errorCode errNo | 107 | user permission denied | iOS | 用户未授予定位权限或未开启精确定位 | 引导用户授予定位权限并开启精确定位
|
|
3475
|
+
* @errorCode errNo | 114 | operation cancelled | iOS | 用户取消了位置权限授权弹窗 | 用户需要时可再次触发授权后重试
|
|
3476
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | 位置授权过程中的网络请求被取消 | 确认应用和网络状态后重试
|
|
3477
|
+
* @errorCode errNo | 302 | connection timed out | iOS | 位置授权过程中的网络连接超时 | 检查网络连接后重试
|
|
3478
|
+
* @errorCode errNo | 303 | no network connection | iOS | 当前无可用网络连接 | 恢复网络连接后重试
|
|
3479
|
+
* @errorCode errNo | 305 | network failure | iOS | 位置授权过程中发生其他网络错误 | 检查网络连接,稍后重试
|
|
3480
|
+
* @errorCode errNo | 112 | invalid result | iOS | 位置授权服务返回的数据无法解析 | 稍后重试;持续失败时反馈服务端响应异常
|
|
3481
|
+
* @platformNote Android | 未连接或因缺少定位权限无法读取时统一返回 1401002;未初始化返回 1401001。
|
|
3482
|
+
* @platformNote iOS | 读取前会发起位置权限授权,可返回 106/107 及授权网络类失败(301/302/303/305/112);读取阶段未连接返回 1401002。
|
|
3366
3483
|
*
|
|
3367
3484
|
* @public
|
|
3368
3485
|
*/
|
|
@@ -3564,7 +3681,21 @@ export declare interface GetFileInfoResult {
|
|
|
3564
3681
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
3565
3682
|
* @precondition All | 无额外前置条件,直接调用 getFileSystemManager 获取管理器实例后再调用其方法
|
|
3566
3683
|
* @usageNote All | readFile、readFileSync 省略 encoding 时默认返回 Base64 字符串,writeFile、appendFile 省略 encoding 时默认按 UTF-8 写入;需要明确编码时请显式传入 encoding。
|
|
3567
|
-
* @
|
|
3684
|
+
* @errorExample
|
|
3685
|
+
* ```json
|
|
3686
|
+
* {
|
|
3687
|
+
* "errNo": 203,
|
|
3688
|
+
* "errMsg": "file does not exist"
|
|
3689
|
+
* }
|
|
3690
|
+
* ```
|
|
3691
|
+
* @errorCode common | 102 | Android,iOS
|
|
3692
|
+
* @errorCode common | 103 | Android
|
|
3693
|
+
* @errorCode common | 104 | Android,iOS
|
|
3694
|
+
* @errorCode errNo | 203 | file does not exist | Android,iOS | readFile、stat、getFileInfo、copyFile、rename、truncate、unlink、rmdir、removeSavedFile、unzip 等操作的目标文件或目录不存在 | 确认路径存在或先创建后重试。
|
|
3695
|
+
* @errorCode errNo | 213 | invalid file path | Android,iOS | 传入的路径不是合法的沙箱内 appletfile 路径,或试图越过沙箱根目录访问 | 使用应用沙箱内的合法本地路径后重试。
|
|
3696
|
+
* @errorCode errNo | 208 | total size limit exceeded | Android,iOS | readFile、writeFile、appendFile、copyFile 时单次读写超过单文件大小上限,或写入后超出沙箱存储配额 | 减小单次读写数据量或清理已保存文件后重试。
|
|
3697
|
+
* @errorCode errNo | 1901001 | target is a directory | Android,iOS | 对目录执行了仅适用于文件的操作(如 readFile、writeFile、appendFile、copyFile、truncate、getFileInfo、unzip 的源文件),或 rmdir 删除非空目录时未开启 recursive | 改为对文件操作,或删除目录时开启 recursive。
|
|
3698
|
+
* @errorCode errNo | 1901002 | target is not a directory | Android,iOS | 对文件执行了仅适用于目录的操作(如 readdir),或 mkdir 目标已存在同名文件、unzip 的 targetPath 不是目录 | 确认目标为目录后重试。
|
|
3568
3699
|
* @public
|
|
3569
3700
|
*/
|
|
3570
3701
|
export declare function getFileSystemManager(): FileSystemManager;
|
|
@@ -3698,7 +3829,19 @@ export declare interface GetImageInfoResult {
|
|
|
3698
3829
|
* "accuracy": 15
|
|
3699
3830
|
* }
|
|
3700
3831
|
* ```
|
|
3701
|
-
* @
|
|
3832
|
+
* @errorExample
|
|
3833
|
+
* ```json
|
|
3834
|
+
* {
|
|
3835
|
+
* "errNo": 107,
|
|
3836
|
+
* "errMsg": "user permission denied"
|
|
3837
|
+
* }
|
|
3838
|
+
* ```
|
|
3839
|
+
* @errorCode common | 102 | Android,iOS
|
|
3840
|
+
* @errorCode common | 116 | Android
|
|
3841
|
+
* @errorCode errNo | 106 | system permission denied | Android,iOS | 系统定位权限被拒绝或系统定位服务不可用 | 引导用户在系统设置中开启定位服务与权限后重试
|
|
3842
|
+
* @errorCode errNo | 107 | user permission denied | Android,iOS | 用户拒绝了应用位置授权(scope.userLocation) | 调用 authorize 重新发起应用授权后重试
|
|
3843
|
+
* @platformNote Android | 用户拒绝应用授权返回 107、系统权限被拒返回 106;定位失败等其他失败统一返回 102。
|
|
3844
|
+
* @platformNote iOS | 应用授权或系统权限被拒返回 107/106;其他失败(含非法 scope)统一返回 102。
|
|
3702
3845
|
* @platformNote iOS | mode 为 1 时按高精度模式处理
|
|
3703
3846
|
*
|
|
3704
3847
|
* @public
|
|
@@ -3834,7 +3977,9 @@ export declare const getMenuButtonBoundingClientRect: () => MenuButtonBoundingCl
|
|
|
3834
3977
|
* "hasSystemProxy": false
|
|
3835
3978
|
* }
|
|
3836
3979
|
* ```
|
|
3837
|
-
* @errorCode
|
|
3980
|
+
* @errorCode common | 102 | Android
|
|
3981
|
+
* @platformNote Android | 正常场景稳定返回网络类型;失败时返回 102。
|
|
3982
|
+
* @platformNote iOS | 始终成功返回网络类型,无失败分支。
|
|
3838
3983
|
*
|
|
3839
3984
|
* @public
|
|
3840
3985
|
*/
|
|
@@ -3925,8 +4070,18 @@ export declare interface GetNetworkTypeResult {
|
|
|
3925
4070
|
* "logId": "20260519xxxx"
|
|
3926
4071
|
* }
|
|
3927
4072
|
* ```
|
|
3928
|
-
* @
|
|
4073
|
+
* @errorExample
|
|
4074
|
+
* ```json
|
|
4075
|
+
* {
|
|
4076
|
+
* "errNo": 114,
|
|
4077
|
+
* "errMsg": "operation cancelled"
|
|
4078
|
+
* }
|
|
4079
|
+
* ```
|
|
4080
|
+
* @errorCode common | 102 | Android,iOS
|
|
4081
|
+
* @errorCode common | 103 | Android,iOS
|
|
4082
|
+
* @errorCode errNo | 114 | operation cancelled | Android | 用户在收银台中取消了支付操作 | 用户需要时可再次调用 `getOrderPayment` 重新拉起收银台。
|
|
3929
4083
|
* @platformNote Android | 需在前台可见的 Activity 中调用,应用退至后台或无有效页面时会返回失败。
|
|
4084
|
+
* @platformNote Android | 用户主动取消支付时返回顶层 errNo 114(operation cancelled);iOS 在该场景不返回顶层专属 errNo。
|
|
3930
4085
|
*
|
|
3931
4086
|
* @public
|
|
3932
4087
|
*/
|
|
@@ -3998,8 +4153,18 @@ export declare interface GetOrderPaymentResult {
|
|
|
3998
4153
|
* "logId": "20260519xxxx"
|
|
3999
4154
|
* }
|
|
4000
4155
|
* ```
|
|
4001
|
-
* @
|
|
4156
|
+
* @errorExample
|
|
4157
|
+
* ```json
|
|
4158
|
+
* {
|
|
4159
|
+
* "errNo": 114,
|
|
4160
|
+
* "errMsg": "operation cancelled"
|
|
4161
|
+
* }
|
|
4162
|
+
* ```
|
|
4163
|
+
* @errorCode common | 102 | Android,iOS
|
|
4164
|
+
* @errorCode common | 103 | Android,iOS
|
|
4165
|
+
* @errorCode errNo | 114 | operation cancelled | Android | 用户在收银台中取消了支付操作 | 用户需要时可再次调用 `getOrderPaymentWithSign` 重新拉起收银台。
|
|
4002
4166
|
* @platformNote Android | 需在前台可见的 Activity 中调用,应用退至后台或无有效页面时会返回失败。
|
|
4167
|
+
* @platformNote Android | 用户主动取消支付时返回顶层 errNo 114(operation cancelled);iOS 在该场景不返回顶层专属 errNo。
|
|
4003
4168
|
*
|
|
4004
4169
|
* @public
|
|
4005
4170
|
*/
|
|
@@ -4105,7 +4270,8 @@ export declare const getPackageInfoSync: () => GetPackageInfoResult;
|
|
|
4105
4270
|
* "needAuthorization": false
|
|
4106
4271
|
* }
|
|
4107
4272
|
* ```
|
|
4108
|
-
* @errorCode
|
|
4273
|
+
* @errorCode common | 102 | Android,iOS
|
|
4274
|
+
* @platformNote All | 该 API 无专属错误码,失败时统一返回 102。
|
|
4109
4275
|
*
|
|
4110
4276
|
* @public
|
|
4111
4277
|
*/
|
|
@@ -4251,7 +4417,7 @@ export declare interface GetSavedFileListResult {
|
|
|
4251
4417
|
* "value": 0.6
|
|
4252
4418
|
* }
|
|
4253
4419
|
* ```
|
|
4254
|
-
* @errorCode
|
|
4420
|
+
* @errorCode common | 102 | Android
|
|
4255
4421
|
*
|
|
4256
4422
|
* @public
|
|
4257
4423
|
*/
|
|
@@ -4298,7 +4464,17 @@ export declare interface GetScreenBrightnessResult {
|
|
|
4298
4464
|
* }
|
|
4299
4465
|
* }
|
|
4300
4466
|
* ```
|
|
4301
|
-
* @
|
|
4467
|
+
* @errorExample
|
|
4468
|
+
* ```json
|
|
4469
|
+
* {
|
|
4470
|
+
* "errNo": 103,
|
|
4471
|
+
* "errMsg": "feature not support"
|
|
4472
|
+
* }
|
|
4473
|
+
* ```
|
|
4474
|
+
* @errorCode common | 102 | Android,iOS
|
|
4475
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 传入 withSubscriptions: true,豆包当前不支持订阅消息模板 | 不要传入 withSubscriptions: true,仅使用默认的 false
|
|
4476
|
+
* @errorCode errNo | 116 | resource not found | Android | 未找到当前应用对应的运行环境记录 | 确认应用已正确安装并在有效运行环境中调用后重试
|
|
4477
|
+
* @platformNote iOS | iOS 不返回 errNo 116(resource not found),相应失败场景统一以 errNo 102(internal error)返回。
|
|
4302
4478
|
*
|
|
4303
4479
|
* @public
|
|
4304
4480
|
*/
|
|
@@ -4713,7 +4889,7 @@ export declare const getSystemInfoSync: (_params?: {}) => GetSystemInfoResult;
|
|
|
4713
4889
|
* "deviceOrientation": "portrait"
|
|
4714
4890
|
* }
|
|
4715
4891
|
* ```
|
|
4716
|
-
* @errorCode
|
|
4892
|
+
* @errorCode common | 102 | Android
|
|
4717
4893
|
* @platformNote Android | wifiEnabled 表示系统 Wi-Fi 开关是否打开
|
|
4718
4894
|
* @platformNote iOS | wifiEnabled 表示当前是否正在通过 Wi-Fi 联网
|
|
4719
4895
|
*
|
|
@@ -4775,7 +4951,26 @@ export declare interface GetSystemSettingResult {
|
|
|
4775
4951
|
* ]
|
|
4776
4952
|
* }
|
|
4777
4953
|
* ```
|
|
4778
|
-
* @
|
|
4954
|
+
* @errorExample
|
|
4955
|
+
* ```json
|
|
4956
|
+
* {
|
|
4957
|
+
* "errNo": 1401001,
|
|
4958
|
+
* "errMsg": "wifi is not initialized"
|
|
4959
|
+
* }
|
|
4960
|
+
* ```
|
|
4961
|
+
* @errorCode common | 102 | Android,iOS
|
|
4962
|
+
* @errorCode errNo | 1401001 | wifi is not initialized | Android,iOS | 调用前未先调用 startWifi 完成初始化 | 先调用 startWifi 再获取 Wi-Fi 列表
|
|
4963
|
+
* @errorCode errNo | 1401002 | wifi is not connected | iOS | iOS 仅返回当前已连接 Wi-Fi,当前未连接时读取失败 | 确认设备已连接 Wi-Fi 后重试
|
|
4964
|
+
* @errorCode errNo | 106 | system permission denied | iOS | 系统定位服务未开启,无法读取 Wi-Fi 信息 | 引导用户在系统设置中开启定位服务
|
|
4965
|
+
* @errorCode errNo | 107 | user permission denied | iOS | 用户未授予定位权限或未开启精确定位 | 引导用户授予定位权限并开启精确定位
|
|
4966
|
+
* @errorCode errNo | 114 | operation cancelled | iOS | 用户取消了位置权限授权弹窗 | 用户需要时可再次触发授权后重试
|
|
4967
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | 位置授权过程中的网络请求被取消 | 确认应用和网络状态后重试
|
|
4968
|
+
* @errorCode errNo | 302 | connection timed out | iOS | 位置授权过程中的网络连接超时 | 检查网络连接后重试
|
|
4969
|
+
* @errorCode errNo | 303 | no network connection | iOS | 当前无可用网络连接 | 恢复网络连接后重试
|
|
4970
|
+
* @errorCode errNo | 305 | network failure | iOS | 位置授权过程中发生其他网络错误 | 检查网络连接,稍后重试
|
|
4971
|
+
* @errorCode errNo | 112 | invalid result | iOS | 位置授权服务返回的数据无法解析 | 稍后重试;持续失败时反馈服务端响应异常
|
|
4972
|
+
* @platformNote Android | 未初始化返回 1401001;扫描列表为空不视为失败;因定位权限不足导致读取失败时返回 102。
|
|
4973
|
+
* @platformNote iOS | 仅返回当前已连接 Wi-Fi,未连接返回 1401002;读取前会发起位置权限授权,可返回 106/107 及授权网络类失败(301/302/303/305/112)。
|
|
4779
4974
|
*
|
|
4780
4975
|
* @public
|
|
4781
4976
|
*/
|
|
@@ -5419,7 +5614,17 @@ export declare const LoginType: {
|
|
|
5419
5614
|
* "result": true
|
|
5420
5615
|
* }
|
|
5421
5616
|
* ```
|
|
5422
|
-
* @
|
|
5617
|
+
* @errorExample
|
|
5618
|
+
* ```json
|
|
5619
|
+
* {
|
|
5620
|
+
* "errNo": 112,
|
|
5621
|
+
* "errMsg": "invalid result"
|
|
5622
|
+
* }
|
|
5623
|
+
* ```
|
|
5624
|
+
* @errorCode common | 102 | Android,iOS
|
|
5625
|
+
* @errorCode errNo | 112 | invalid result | Android | 登录或隐私状态查询成功但返回数据缺失(如缺少隐私卡片或手机掩码) | 稍后重试;持续失败时反馈服务端响应异常。
|
|
5626
|
+
* @platformNote Android | 状态查询成功但关键数据缺失返回 112;其他失败统一返回 102。
|
|
5627
|
+
* @platformNote iOS | 失败统一返回 102。
|
|
5423
5628
|
*
|
|
5424
5629
|
* @public
|
|
5425
5630
|
*/
|
|
@@ -5528,7 +5733,16 @@ export declare interface MakeBluetoothPairParams {
|
|
|
5528
5733
|
* ```json
|
|
5529
5734
|
* {}
|
|
5530
5735
|
* ```
|
|
5531
|
-
* @
|
|
5736
|
+
* @errorExample
|
|
5737
|
+
* ```json
|
|
5738
|
+
* {
|
|
5739
|
+
* "errNo": 104,
|
|
5740
|
+
* "errMsg": "invalid parameter"
|
|
5741
|
+
* }
|
|
5742
|
+
* ```
|
|
5743
|
+
* @errorCode common | 102 | Android,iOS
|
|
5744
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | phoneNumber 为空,或在 iOS 上无法拼接为有效的拨号 URL | 传入合法的电话号码后重试。
|
|
5745
|
+
* @errorCode errNo | 103 | feature not support | iOS | 当前设备不支持拨打电话 | 在支持拨号的设备上调用,或提前提示用户设备不支持拨号。
|
|
5532
5746
|
*
|
|
5533
5747
|
* @public
|
|
5534
5748
|
*/
|
|
@@ -5601,7 +5815,7 @@ export declare interface MkdirParams {
|
|
|
5601
5815
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
5602
5816
|
* @precondition All | 无额外前置条件
|
|
5603
5817
|
* @usageNote All | navigateBack 只能在页面栈内返回;当前页面已是页面栈中的最后一个页面时无法继续返回,需要退出智能服务请调用 exitApp。
|
|
5604
|
-
* @errorCode
|
|
5818
|
+
* @errorCode common | 102 | Android,iOS
|
|
5605
5819
|
*
|
|
5606
5820
|
* @public
|
|
5607
5821
|
*/
|
|
@@ -5638,7 +5852,15 @@ export declare interface NavigateBackParams {
|
|
|
5638
5852
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
5639
5853
|
* @precondition All | 无额外前置条件
|
|
5640
5854
|
* @usageNote All | url 为智能服务内的页面路径,可携带查询参数;跳转后当前页面会保留在页面栈中,可通过 navigateBack 返回。
|
|
5641
|
-
* @
|
|
5855
|
+
* @errorExample
|
|
5856
|
+
* ```json
|
|
5857
|
+
* {
|
|
5858
|
+
* "errNo": 104,
|
|
5859
|
+
* "errMsg": "invalid url"
|
|
5860
|
+
* }
|
|
5861
|
+
* ```
|
|
5862
|
+
* @errorCode common | 102 | Android,iOS
|
|
5863
|
+
* @errorCode errNo | 104 | invalid url | Android,iOS | url 为空或无法解析为有效的智能服务页面路径 | 检查 url 是否为合法的应用内页面路径后重试。
|
|
5642
5864
|
*
|
|
5643
5865
|
* @public
|
|
5644
5866
|
*/
|
|
@@ -6431,73 +6653,6 @@ export declare const onUserScreenRecord: ClientEventRegistry<UserScreenRecordEve
|
|
|
6431
6653
|
*/
|
|
6432
6654
|
export declare const onWifiConnected: ClientEventRegistry<WifiConnectedEvent>;
|
|
6433
6655
|
|
|
6434
|
-
/**
|
|
6435
|
-
* 通过 deep link 等方式打开外部应用。
|
|
6436
|
-
*
|
|
6437
|
-
* @param params - 外部应用打开参数。
|
|
6438
|
-
* @returns 返回一个 Promise,成功时解析为外部应用打开结果({@link OpenAppResult})。
|
|
6439
|
-
* @example
|
|
6440
|
-
* ```typescript
|
|
6441
|
-
* import { openApp } from '@doubao-dev/framework/api';
|
|
6442
|
-
*
|
|
6443
|
-
* const { status } = await openApp({
|
|
6444
|
-
* uri: 'demo://detail?id=1',
|
|
6445
|
-
* fallbackUrl: 'https://example.com/download'
|
|
6446
|
-
* });
|
|
6447
|
-
*
|
|
6448
|
-
* console.log(status);
|
|
6449
|
-
* ```
|
|
6450
|
-
*
|
|
6451
|
-
* @since 0.0.6
|
|
6452
|
-
* @contractStatus conflict | Android 已实现,iOS 未提供可调用实现。
|
|
6453
|
-
* @contractMismatch blocking | platform | 打开外部应用 | iOS | 通过 applet.openApp 打开外部应用并返回执行方式 status | 豆包 iOS 暂未提供该能力,调用会返回不支持 | 该 API 在豆包 iOS 无法打开外部应用 | packages/open-api/src/open/business/open-app.ts; ai-sdk/ios/AISDK/Sources/JSBridge/IDL/AbsOpenAppMethodIDL.swift | 补齐豆包 iOS applet.openApp 实现后再在该平台开放文档
|
|
6454
|
-
* @platformSupport Android | supported | 支持通过 deep link、应用市场或浏览器兜底打开外部应用。
|
|
6455
|
-
* @platformSupport iOS | unsupported | 豆包当前未实现打开外部应用能力。
|
|
6456
|
-
* @platformSupport PC | unsupported | 当前未提供该平台实现。
|
|
6457
|
-
* @platformSupport HarmonyOS | unsupported | 当前未提供该平台实现。
|
|
6458
|
-
* @permission none | - | none | Android | 无需额外权限
|
|
6459
|
-
* @precondition Android | 传入合法的 uri。
|
|
6460
|
-
* @usageNote All | 建议同时传入 fallbackUrl,当目标应用未安装、deep link 无法命中时可兜底至应用市场或浏览器。iOS 暂不支持,请勿在该平台调用。
|
|
6461
|
-
* @resultExample
|
|
6462
|
-
* ```json
|
|
6463
|
-
* {
|
|
6464
|
-
* "status": "deep_link"
|
|
6465
|
-
* }
|
|
6466
|
-
* ```
|
|
6467
|
-
* @platformNote Android | 客户端会依次尝试 deep link、应用市场、浏览器,并通过 status 返回实际执行方式(deep_link、market、browser)。
|
|
6468
|
-
* @errorCode none | - | - | Android | 无 API 专属错误码 | 无需处理
|
|
6469
|
-
*
|
|
6470
|
-
* @public
|
|
6471
|
-
*/
|
|
6472
|
-
export declare const openApp: (params: OpenAppRequest) => Promise<OpenAppResult>;
|
|
6473
|
-
|
|
6474
|
-
/** @public */
|
|
6475
|
-
export declare interface OpenAppRequest {
|
|
6476
|
-
/** 要打开的目标 URI,例如 `scheme://path?query`。 */
|
|
6477
|
-
uri: string;
|
|
6478
|
-
/**
|
|
6479
|
-
* Android 上的目标应用包名,可选。
|
|
6480
|
-
*
|
|
6481
|
-
* @default -
|
|
6482
|
-
*/
|
|
6483
|
-
targetPackage?: string;
|
|
6484
|
-
/**
|
|
6485
|
-
* deep link 失败时的兜底 URL,可选。
|
|
6486
|
-
*
|
|
6487
|
-
* @default -
|
|
6488
|
-
*/
|
|
6489
|
-
fallbackUrl?: string;
|
|
6490
|
-
}
|
|
6491
|
-
|
|
6492
|
-
/** @public */
|
|
6493
|
-
export declare interface OpenAppResult {
|
|
6494
|
-
/** 客户端实际执行的打开方式。 */
|
|
6495
|
-
status: OpenAppStatus;
|
|
6496
|
-
}
|
|
6497
|
-
|
|
6498
|
-
/** @public */
|
|
6499
|
-
export declare type OpenAppStatus = 'deep_link' | 'market' | 'browser';
|
|
6500
|
-
|
|
6501
6656
|
/**
|
|
6502
6657
|
* 打开蓝牙适配器。
|
|
6503
6658
|
*
|
|
@@ -6723,7 +6878,24 @@ export declare interface PluginAccountInfo {
|
|
|
6723
6878
|
* @precondition Android | 先完成登录,并传入登录成功返回的有效 code。
|
|
6724
6879
|
* @precondition iOS | 先完成登录,并传入登录成功返回的有效 code。
|
|
6725
6880
|
* @usageNote All | 仅在完成 MCP 授权登录流程后回传结果;登录成功时必须携带有效 code,回传成功后不要重复回传。
|
|
6726
|
-
* @
|
|
6881
|
+
* @errorExample
|
|
6882
|
+
* ```json
|
|
6883
|
+
* {
|
|
6884
|
+
* "errNo": 105,
|
|
6885
|
+
* "errMsg": "authentication fail"
|
|
6886
|
+
* }
|
|
6887
|
+
* ```
|
|
6888
|
+
* @errorCode common | 102 | Android,iOS
|
|
6889
|
+
* @errorCode errNo | 104 | invalid parameter | Android | result 为 true 但缺少有效的兑换 code | 传入业务服务端生成的有效 code 后重试。
|
|
6890
|
+
* @errorCode errNo | 105 | authentication fail | Android,iOS | 登录被拒绝或兑换 code 校验未通过 | 确认业务登录状态与 code 是否有效后重试。
|
|
6891
|
+
* @errorCode errNo | 112 | invalid result | Android,iOS | Token 交换服务返回的数据无法解析 | 稍后重试;持续失败时反馈服务端响应异常。
|
|
6892
|
+
* @errorCode errNo | 115 | operation timeout | Android | Token 交换耗时超过限制 | 检查网络后重试。
|
|
6893
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | Token 交换的网络请求被取消 | 确认应用和网络状态后重试。
|
|
6894
|
+
* @errorCode errNo | 302 | connection timed out | Android,iOS | Token 交换的网络连接超时 | 检查网络连接后重试。
|
|
6895
|
+
* @errorCode errNo | 303 | no network connection | Android,iOS | 当前无可用网络连接 | 恢复网络连接后重试。
|
|
6896
|
+
* @errorCode errNo | 305 | network failure | Android,iOS | Token 交换时发生其他网络错误 | 检查网络连接,稍后重试。
|
|
6897
|
+
* @platformNote Android | 缺少有效 code 时返回 104;调用超时返回 115。
|
|
6898
|
+
* @platformNote iOS | 缺少有效 code 时返回 102;网络请求被取消时返回 301,超时归类为 302。
|
|
6727
6899
|
*
|
|
6728
6900
|
* @public
|
|
6729
6901
|
*/
|
|
@@ -7133,7 +7305,15 @@ export declare type RecorderSampleRate = 8000 | 11025 | 12000 | 16000 | 22050 |
|
|
|
7133
7305
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
7134
7306
|
* @precondition All | 无额外前置条件
|
|
7135
7307
|
* @usageNote All | url 为智能服务内的页面路径,可携带查询参数;跳转会替换当前页面,不保留在页面栈中。
|
|
7136
|
-
* @
|
|
7308
|
+
* @errorExample
|
|
7309
|
+
* ```json
|
|
7310
|
+
* {
|
|
7311
|
+
* "errNo": 104,
|
|
7312
|
+
* "errMsg": "invalid url"
|
|
7313
|
+
* }
|
|
7314
|
+
* ```
|
|
7315
|
+
* @errorCode common | 102 | Android,iOS
|
|
7316
|
+
* @errorCode errNo | 104 | invalid url | Android,iOS | url 为空或无法解析为有效的智能服务页面路径 | 检查 url 是否为合法的应用内页面路径后重试。
|
|
7137
7317
|
*
|
|
7138
7318
|
* @public
|
|
7139
7319
|
*/
|
|
@@ -7160,7 +7340,15 @@ export declare const redirectTo: (params: NavigateToParams) => Promise<object>;
|
|
|
7160
7340
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
7161
7341
|
* @precondition All | 无额外前置条件
|
|
7162
7342
|
* @usageNote All | url 为智能服务内的页面路径,可携带查询参数;跳转会关闭现有全部页面并以目标页面作为唯一页面。
|
|
7163
|
-
* @
|
|
7343
|
+
* @errorExample
|
|
7344
|
+
* ```json
|
|
7345
|
+
* {
|
|
7346
|
+
* "errNo": 104,
|
|
7347
|
+
* "errMsg": "invalid url"
|
|
7348
|
+
* }
|
|
7349
|
+
* ```
|
|
7350
|
+
* @errorCode common | 102 | Android,iOS
|
|
7351
|
+
* @errorCode errNo | 104 | invalid url | Android,iOS | url 为空或无法解析为有效的智能服务页面路径 | 检查 url 是否为合法的应用内页面路径后重试。
|
|
7164
7352
|
*
|
|
7165
7353
|
* @public
|
|
7166
7354
|
*/
|
|
@@ -7337,7 +7525,7 @@ export declare interface RenameParams {
|
|
|
7337
7525
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
7338
7526
|
* @precondition All | 无额外前置条件。
|
|
7339
7527
|
* @usageNote All | 事件名与事件参数会用于数据分析,请勿写入用户隐私或敏感数据。
|
|
7340
|
-
* @errorCode
|
|
7528
|
+
* @errorCode common | 102 | Android,iOS
|
|
7341
7529
|
*
|
|
7342
7530
|
* @public
|
|
7343
7531
|
*/
|
|
@@ -7402,7 +7590,22 @@ export declare interface ReportEventParams {
|
|
|
7402
7590
|
* }
|
|
7403
7591
|
* }
|
|
7404
7592
|
* ```
|
|
7405
|
-
* @
|
|
7593
|
+
* @errorExample
|
|
7594
|
+
* ```json
|
|
7595
|
+
* {
|
|
7596
|
+
* "errNo": 305,
|
|
7597
|
+
* "errMsg": "network failure"
|
|
7598
|
+
* }
|
|
7599
|
+
* ```
|
|
7600
|
+
* @errorCode common | 102 | iOS
|
|
7601
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | url 为空、method 非法,或请求参数、请求体校验失败 | 修正 url、method 与请求参数后重试。
|
|
7602
|
+
* @errorCode errNo | 110 | API call prohibited | Android,iOS | 请求 URL 未通过域名白名单校验 | 确认目标域名已在智能服务中配置后重试。
|
|
7603
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | 网络请求被取消 | 确认应用与网络状态后重试。
|
|
7604
|
+
* @errorCode errNo | 302 | connection timed out | Android,iOS | 网络连接超时 | 检查网络连接后重试。
|
|
7605
|
+
* @errorCode errNo | 303 | no network connection | Android,iOS | 当前无可用网络连接 | 恢复网络连接后重试。
|
|
7606
|
+
* @errorCode errNo | 305 | network failure | Android,iOS | 发生其他网络错误 | 检查网络连接,稍后重试。
|
|
7607
|
+
* @platformNote Android | 网络失败仅细分为 302(HTTP 408 超时)、303(无网络连接)与 305(其他网络错误),不返回 301;url 为空或 method 非法返回 104;命中域名管控返回 110。
|
|
7608
|
+
* @platformNote iOS | 依据 NSURLError 细分网络失败:请求取消 301、连接超时 302、无网络 303、其他 305;参数或请求体校验失败返回 104;命中域名管控返回 110;其他失败统一返回 102。
|
|
7406
7609
|
*
|
|
7407
7610
|
* @public
|
|
7408
7611
|
*/
|
|
@@ -7455,7 +7658,7 @@ export declare type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' |
|
|
|
7455
7658
|
* "logId": "20260519xxxx"
|
|
7456
7659
|
* }
|
|
7457
7660
|
* ```
|
|
7458
|
-
* @errorCode
|
|
7661
|
+
* @errorCode common | 102 | Android,iOS
|
|
7459
7662
|
* @knownIssue All | 失败结果不会作为 await 的返回值,需通过 catch 捕获并从错误对象的 data 字段读取 errNo、errMsg、errLogId。
|
|
7460
7663
|
*
|
|
7461
7664
|
* @public
|
|
@@ -7691,7 +7894,16 @@ export declare interface SaveImageToPhotosAlbumParams {
|
|
|
7691
7894
|
* "scanType": "QR_CODE"
|
|
7692
7895
|
* }
|
|
7693
7896
|
* ```
|
|
7694
|
-
* @
|
|
7897
|
+
* @errorExample
|
|
7898
|
+
* ```json
|
|
7899
|
+
* {
|
|
7900
|
+
* "errNo": 103,
|
|
7901
|
+
* "errMsg": "feature not support"
|
|
7902
|
+
* }
|
|
7903
|
+
* ```
|
|
7904
|
+
* @errorCode common | 102 | Android,iOS
|
|
7905
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前豆包版本或运行环境未提供扫码能力 | 在支持扫码能力的豆包版本中调用。
|
|
7906
|
+
* @errorCode errNo | 112 | invalid result | iOS | 扫码成功但未返回可用的扫码结果数据 | 稍后重试;持续失败时反馈扫码结果异常。
|
|
7695
7907
|
*
|
|
7696
7908
|
* @public
|
|
7697
7909
|
*/
|
|
@@ -7761,7 +7973,7 @@ export declare type Scope = 'scope.userLocation' | 'scope.userFuzzyLocation' | '
|
|
|
7761
7973
|
export declare type SelectedMessageFileType = 'video' | 'image' | 'file';
|
|
7762
7974
|
|
|
7763
7975
|
/**
|
|
7764
|
-
*
|
|
7976
|
+
* 以用户身份发送后续消息,触发新一轮对话、API 调用或引导模型响应。
|
|
7765
7977
|
*
|
|
7766
7978
|
* @param params - 要发送的后续消息内容。
|
|
7767
7979
|
* @returns 返回一个 Promise,在消息发送请求提交后解析。
|
|
@@ -7782,6 +7994,13 @@ export declare type SelectedMessageFileType = 'video' | 'image' | 'file';
|
|
|
7782
7994
|
* name: 'selectDrink',
|
|
7783
7995
|
* arguments: { drinkId: 'latte_001' }
|
|
7784
7996
|
* }
|
|
7997
|
+
* },
|
|
7998
|
+
* {
|
|
7999
|
+
* type: 'responseHint',
|
|
8000
|
+
* data: {
|
|
8001
|
+
* userAction: '用户选择了拿铁',
|
|
8002
|
+
* responseGuidance: '确认已选择拿铁,并询问是否需要调整杯型'
|
|
8003
|
+
* }
|
|
7785
8004
|
* }
|
|
7786
8005
|
* ]
|
|
7787
8006
|
* });
|
|
@@ -7823,7 +8042,7 @@ export declare interface SendFollowUpMessageParams {
|
|
|
7823
8042
|
*
|
|
7824
8043
|
* @param params - 消息内容及类型。
|
|
7825
8044
|
* @returns 返回一个 Promise,在消息成功发送时解析。
|
|
7826
|
-
* @deprecated 使用 {@link
|
|
8045
|
+
* @deprecated 使用 {@link sendFollowUpMessage} 发送后续消息。
|
|
7827
8046
|
* @summary 以用户身份发送消息。
|
|
7828
8047
|
* @example
|
|
7829
8048
|
* ```typescript
|
|
@@ -7844,7 +8063,7 @@ export declare interface SendFollowUpMessageParams {
|
|
|
7844
8063
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
7845
8064
|
* @precondition Android | 在卡片或页面环境中调用,由客户端自动获取页面上下文确定目标 bot。
|
|
7846
8065
|
* @precondition iOS | 在卡片或页面环境中调用,由客户端自动获取页面上下文确定目标 bot。
|
|
7847
|
-
* @usageNote All | 该 API 已废弃,请改用
|
|
8066
|
+
* @usageNote All | 该 API 已废弃,请改用 sendFollowUpMessage 发送后续消息。
|
|
7848
8067
|
* @errorCode none | - | - | Android,iOS | 无 API 专属错误码 | 无需处理
|
|
7849
8068
|
*
|
|
7850
8069
|
* @internal
|
|
@@ -7887,7 +8106,17 @@ export declare interface SendQueryMessageParams {
|
|
|
7887
8106
|
* ```json
|
|
7888
8107
|
* {}
|
|
7889
8108
|
* ```
|
|
7890
|
-
* @
|
|
8109
|
+
* @errorExample
|
|
8110
|
+
* ```json
|
|
8111
|
+
* {
|
|
8112
|
+
* "errNo": 114,
|
|
8113
|
+
* "errMsg": "operation cancelled"
|
|
8114
|
+
* }
|
|
8115
|
+
* ```
|
|
8116
|
+
* @errorCode common | 102 | Android,iOS
|
|
8117
|
+
* @errorCode errNo | 103 | feature not support | iOS | 当前设备不支持发送短信 | 在支持短信的设备上调用,或提前提示用户设备不支持短信。
|
|
8118
|
+
* @errorCode errNo | 114 | operation cancelled | iOS | 用户在系统短信面板中取消了发送 | 用户需要时可再次调用 `sendSms` 重新拉起短信面板。
|
|
8119
|
+
* @platformNote iOS | 拉起短信面板后用户取消返回 114、发送失败返回 102、设备不支持短信返回 103;Android 无法拉起短信应用时返回 102。
|
|
7891
8120
|
*
|
|
7892
8121
|
* @public
|
|
7893
8122
|
*/
|
|
@@ -7948,7 +8177,18 @@ export declare type SensorInterval = 'game' | 'ui' | 'normal';
|
|
|
7948
8177
|
* @precondition Android | 无额外前置条件
|
|
7949
8178
|
* @precondition iOS | 无额外前置条件
|
|
7950
8179
|
* @usageNote All | 该 API 已废弃,请改用 updateModelContext 按任务或实体维度补充模型上下文。
|
|
7951
|
-
* @
|
|
8180
|
+
* @errorExample
|
|
8181
|
+
* ```json
|
|
8182
|
+
* {
|
|
8183
|
+
* "errNo": 103,
|
|
8184
|
+
* "errMsg": "feature not support"
|
|
8185
|
+
* }
|
|
8186
|
+
* ```
|
|
8187
|
+
* @errorCode common | 102 | Android,iOS
|
|
8188
|
+
* @errorCode errNo | 103 | feature not support | Android | 当前容器类型不支持设置全局上下文 | 请在支持的容器(页面、卡片或 Worker)环境中调用。
|
|
8189
|
+
* @errorCode errNo | 104 | invalid parameter | iOS | 传入的参数结构非法,无法解析 | 检查传入的参数结构后重试。
|
|
8190
|
+
* @platformNote Android | 当前容器类型不受支持返回 103;其他失败统一返回 102。
|
|
8191
|
+
* @platformNote iOS | 参数结构非法返回 104;其他失败统一返回 102。
|
|
7952
8192
|
*
|
|
7953
8193
|
* @internal
|
|
7954
8194
|
*/
|
|
@@ -8054,7 +8294,16 @@ export declare interface SetBLEMTUResult {
|
|
|
8054
8294
|
* ```json
|
|
8055
8295
|
* {}
|
|
8056
8296
|
* ```
|
|
8057
|
-
* @
|
|
8297
|
+
* @errorExample
|
|
8298
|
+
* ```json
|
|
8299
|
+
* {
|
|
8300
|
+
* "errNo": 103,
|
|
8301
|
+
* "errMsg": "feature not support"
|
|
8302
|
+
* }
|
|
8303
|
+
* ```
|
|
8304
|
+
* @errorCode common | 102 | Android,iOS
|
|
8305
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前豆包版本或运行环境未提供剪贴板写入能力 | 在支持剪贴板能力的豆包版本中调用。
|
|
8306
|
+
* @errorCode errNo | 106 | system permission denied | Android | 写入后系统未授予剪贴板访问权限,写入未生效 | 引导用户在系统设置中开启剪贴板相关权限后重试。
|
|
8058
8307
|
*
|
|
8059
8308
|
* @public
|
|
8060
8309
|
*/
|
|
@@ -8088,11 +8337,12 @@ export declare interface SetClipboardDataParams {
|
|
|
8088
8337
|
* @precondition All | 无额外前置条件
|
|
8089
8338
|
* @usageNote All | 不再需要常亮时应主动将 keepScreenOn 设为 false,避免额外功耗
|
|
8090
8339
|
* @platformNote iOS | 页面销毁后常亮状态会自动恢复
|
|
8340
|
+
* @platformNote iOS | 设置常亮恒返回成功,无失败错误码
|
|
8091
8341
|
* @resultExample
|
|
8092
8342
|
* ```json
|
|
8093
8343
|
* {}
|
|
8094
8344
|
* ```
|
|
8095
|
-
* @errorCode
|
|
8345
|
+
* @errorCode common | 102 | Android
|
|
8096
8346
|
*
|
|
8097
8347
|
* @public
|
|
8098
8348
|
*/
|
|
@@ -8228,7 +8478,17 @@ export declare function setStorageSync<TData = unknown>(params: SetStorageParams
|
|
|
8228
8478
|
* ```json
|
|
8229
8479
|
* {}
|
|
8230
8480
|
* ```
|
|
8231
|
-
* @
|
|
8481
|
+
* @errorExample
|
|
8482
|
+
* ```json
|
|
8483
|
+
* {
|
|
8484
|
+
* "errNo": 1401001,
|
|
8485
|
+
* "errMsg": "wifi is not initialized"
|
|
8486
|
+
* }
|
|
8487
|
+
* ```
|
|
8488
|
+
* @errorCode common | 102 | iOS
|
|
8489
|
+
* @errorCode errNo | 103 | feature not support | Android | 该 API 为 iOS 特有,Android 调用固定失败 | 不要在 Android 调用该 API
|
|
8490
|
+
* @errorCode errNo | 1401001 | wifi is not initialized | iOS | 调用前未先调用 startWifi 完成初始化 | 先调用 startWifi 再设置预设列表
|
|
8491
|
+
* @platformNote Android | 固定返回 103(该能力仅 iOS);iOS 未初始化返回 1401001,其他失败统一返回 102。
|
|
8232
8492
|
*
|
|
8233
8493
|
* @public
|
|
8234
8494
|
*/
|
|
@@ -8273,7 +8533,16 @@ export declare interface SetWifiListParams {
|
|
|
8273
8533
|
* "tapIndex": 0
|
|
8274
8534
|
* }
|
|
8275
8535
|
* ```
|
|
8276
|
-
* @
|
|
8536
|
+
* @errorExample
|
|
8537
|
+
* ```json
|
|
8538
|
+
* {
|
|
8539
|
+
* "errNo": 114,
|
|
8540
|
+
* "errMsg": "operation cancelled"
|
|
8541
|
+
* }
|
|
8542
|
+
* ```
|
|
8543
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | itemList 为空数组 | 传入至少一个菜单项后重试。
|
|
8544
|
+
* @errorCode errNo | 114 | operation cancelled | Android,iOS | 用户点击 Cancel 按钮或点击蒙层关闭操作菜单 | 用户主动取消,按需静默处理。
|
|
8545
|
+
* @errorCode common | 102 | Android,iOS
|
|
8277
8546
|
*
|
|
8278
8547
|
* @public
|
|
8279
8548
|
*/
|
|
@@ -8355,8 +8624,16 @@ export declare interface ShowActionSheetResult {
|
|
|
8355
8624
|
* "role": "agreeMain"
|
|
8356
8625
|
* }
|
|
8357
8626
|
* ```
|
|
8358
|
-
* @
|
|
8359
|
-
*
|
|
8627
|
+
* @errorExample
|
|
8628
|
+
* ```json
|
|
8629
|
+
* {
|
|
8630
|
+
* "errNo": 104,
|
|
8631
|
+
* "errMsg": "invalid parameter"
|
|
8632
|
+
* }
|
|
8633
|
+
* ```
|
|
8634
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | title 或 content 为空、content 含被拦截的标签/事件属性/危险链接、buttons 数量不在 1-3 范围;iOS 还会在按钮语义重复或按钮文案为空时返回 | 修正参数后重试。
|
|
8635
|
+
* @errorCode errNo | 103 | feature not support | iOS | 豆包底部弹窗能力不可用,或按钮数为 3 时当前 provider 不支持三按钮 | 降级到自定义弹窗;同场景 Android 返回 action=cancel、source=hostUnavailable 的成功结果,请一并做降级处理。
|
|
8636
|
+
* @platformNote iOS | provider 不可用或不支持三按钮时返回 errNo 103 失败;Android 在 provider 不可用时返回 action=cancel、source=hostUnavailable 的成功结果,且不校验三按钮能力。
|
|
8360
8637
|
*
|
|
8361
8638
|
* @public
|
|
8362
8639
|
*/
|
|
@@ -8410,7 +8687,7 @@ export declare type ShowBottomSheetResult = BottomSheetButtonClickResult | Botto
|
|
|
8410
8687
|
* @permission none | - | none | Android,iOS | 无需额外权限
|
|
8411
8688
|
* @precondition All | 无额外前置条件
|
|
8412
8689
|
* @usageNote All | loading 展示后需调用 hideLoading 手动关闭。
|
|
8413
|
-
* @errorCode
|
|
8690
|
+
* @errorCode common | 102 | Android,iOS
|
|
8414
8691
|
*
|
|
8415
8692
|
* @public
|
|
8416
8693
|
*/
|
|
@@ -8459,7 +8736,7 @@ export declare interface ShowLoadingParams {
|
|
|
8459
8736
|
* "action": "confirm"
|
|
8460
8737
|
* }
|
|
8461
8738
|
* ```
|
|
8462
|
-
* @errorCode
|
|
8739
|
+
* @errorCode common | 102 | Android,iOS
|
|
8463
8740
|
*
|
|
8464
8741
|
* @public
|
|
8465
8742
|
*/
|
|
@@ -8562,7 +8839,17 @@ export declare interface ShowModalResult {
|
|
|
8562
8839
|
* ```json
|
|
8563
8840
|
* {}
|
|
8564
8841
|
* ```
|
|
8565
|
-
* @
|
|
8842
|
+
* @errorExample
|
|
8843
|
+
* ```json
|
|
8844
|
+
* {
|
|
8845
|
+
* "errNo": 104,
|
|
8846
|
+
* "errMsg": "invalid parameter"
|
|
8847
|
+
* }
|
|
8848
|
+
* ```
|
|
8849
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | message 为空;iOS 还会在 icon 取值非法或入参无法解析时返回(type 由前端归一化为合法值,非法 type 场景不会触发) | 修正参数后重试。
|
|
8850
|
+
* @errorCode errNo | 103 | feature not support | iOS | 豆包 UIService 未实现,无法展示 Toast | 降级到其他提示方式。
|
|
8851
|
+
* @errorCode common | 102 | Android
|
|
8852
|
+
* @platformNote iOS | 参数校验失败统一返回 errNo 104;UIService 缺失时返回 errNo 103。Android 参数校验失败返回 errNo 104,宿主上下文缺失返回 errNo 102。
|
|
8566
8853
|
*
|
|
8567
8854
|
* @public
|
|
8568
8855
|
* */
|
|
@@ -8643,8 +8930,18 @@ export declare interface ShowToastParams {
|
|
|
8643
8930
|
* ```json
|
|
8644
8931
|
* {}
|
|
8645
8932
|
* ```
|
|
8646
|
-
* @
|
|
8933
|
+
* @errorExample
|
|
8934
|
+
* ```json
|
|
8935
|
+
* {
|
|
8936
|
+
* "errNo": 114,
|
|
8937
|
+
* "errMsg": "operation cancelled"
|
|
8938
|
+
* }
|
|
8939
|
+
* ```
|
|
8940
|
+
* @errorCode common | 102 | Android,iOS
|
|
8941
|
+
* @errorCode common | 103 | Android,iOS
|
|
8942
|
+
* @errorCode errNo | 114 | operation cancelled | Android | 用户在签约收银台中取消了签约操作 | 用户需要时可再次调用 `sign` 重新发起签约。
|
|
8647
8943
|
* @platformNote Android | 需在前台可见的 Activity 中调用,应用退至后台或无有效页面时会返回失败。
|
|
8944
|
+
* @platformNote Android | 用户主动取消签约时返回顶层 errNo 114(operation cancelled);iOS 在该场景不返回顶层专属 errNo。
|
|
8648
8945
|
* @knownIssue All | 失败结果不会作为 await 的返回值,需通过 catch 捕获并从错误对象的 data 字段读取 code、errNo、errMsg、errLogId。
|
|
8649
8946
|
*
|
|
8650
8947
|
* @public
|
|
@@ -8965,7 +9262,15 @@ export declare interface SocketTaskSendParams {
|
|
|
8965
9262
|
* ```json
|
|
8966
9263
|
* {}
|
|
8967
9264
|
* ```
|
|
8968
|
-
* @
|
|
9265
|
+
* @errorExample
|
|
9266
|
+
* ```json
|
|
9267
|
+
* {
|
|
9268
|
+
* "errNo": 103,
|
|
9269
|
+
* "errMsg": "feature not support"
|
|
9270
|
+
* }
|
|
9271
|
+
* ```
|
|
9272
|
+
* @errorCode common | 102 | Android,iOS
|
|
9273
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前设备不支持加速度传感器或无法注册监听 | 在具备加速度传感器的设备上调用,或提前提示用户设备不支持。
|
|
8969
9274
|
*
|
|
8970
9275
|
* @public
|
|
8971
9276
|
*/
|
|
@@ -9145,7 +9450,15 @@ export declare interface StartBluetoothDevicesDiscoveryParams {
|
|
|
9145
9450
|
* ```json
|
|
9146
9451
|
* {}
|
|
9147
9452
|
* ```
|
|
9148
|
-
* @
|
|
9453
|
+
* @errorExample
|
|
9454
|
+
* ```json
|
|
9455
|
+
* {
|
|
9456
|
+
* "errNo": 103,
|
|
9457
|
+
* "errMsg": "feature not support"
|
|
9458
|
+
* }
|
|
9459
|
+
* ```
|
|
9460
|
+
* @errorCode common | 102 | Android,iOS
|
|
9461
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前设备不支持罗盘传感器或无法注册监听 | 在具备罗盘传感器的设备上调用,或提前提示用户设备不支持。
|
|
9149
9462
|
*
|
|
9150
9463
|
* @public
|
|
9151
9464
|
*/
|
|
@@ -9176,7 +9489,15 @@ export declare const startCompass: (params?: {} | undefined) => Promise<object>;
|
|
|
9176
9489
|
* ```json
|
|
9177
9490
|
* {}
|
|
9178
9491
|
* ```
|
|
9179
|
-
* @
|
|
9492
|
+
* @errorExample
|
|
9493
|
+
* ```json
|
|
9494
|
+
* {
|
|
9495
|
+
* "errNo": 103,
|
|
9496
|
+
* "errMsg": "feature not support"
|
|
9497
|
+
* }
|
|
9498
|
+
* ```
|
|
9499
|
+
* @errorCode common | 102 | Android,iOS
|
|
9500
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前设备不支持方向传感器或无法注册监听 | 在具备方向传感器的设备上调用,或提前提示用户设备不支持。
|
|
9180
9501
|
*
|
|
9181
9502
|
* @public
|
|
9182
9503
|
*/
|
|
@@ -9222,7 +9543,15 @@ export declare interface StartDeviceMotionListeningParams {
|
|
|
9222
9543
|
* ```json
|
|
9223
9544
|
* {}
|
|
9224
9545
|
* ```
|
|
9225
|
-
* @
|
|
9546
|
+
* @errorExample
|
|
9547
|
+
* ```json
|
|
9548
|
+
* {
|
|
9549
|
+
* "errNo": 103,
|
|
9550
|
+
* "errMsg": "feature not support"
|
|
9551
|
+
* }
|
|
9552
|
+
* ```
|
|
9553
|
+
* @errorCode common | 102 | Android,iOS
|
|
9554
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前设备不支持陀螺仪传感器或无法注册监听 | 在具备陀螺仪传感器的设备上调用,或提前提示用户设备不支持。
|
|
9226
9555
|
*
|
|
9227
9556
|
* @public
|
|
9228
9557
|
*/
|
|
@@ -9276,7 +9605,22 @@ export declare interface StartGyroscopeParams {
|
|
|
9276
9605
|
* ```json
|
|
9277
9606
|
* {}
|
|
9278
9607
|
* ```
|
|
9279
|
-
* @
|
|
9608
|
+
* @errorExample
|
|
9609
|
+
* ```json
|
|
9610
|
+
* {
|
|
9611
|
+
* "errNo": 1700001,
|
|
9612
|
+
* "errMsg": "location permission denied"
|
|
9613
|
+
* }
|
|
9614
|
+
* ```
|
|
9615
|
+
* @errorCode common | 102 | Android,iOS
|
|
9616
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 宿主未注册持续定位能力(location service 不可用) | 确认宿主已集成持续定位能力,不可用时不要调用
|
|
9617
|
+
* @errorCode errNo | 114 | operation cancelled | Android,iOS | 启动过程中被取消(用户取消授权,或授权返回前已调用 stopLocationUpdate) | 需要时重新调用 startLocationUpdate
|
|
9618
|
+
* @errorCode errNo | 118 | already exists | Android,iOS | 持续定位已启动,重复调用 startLocationUpdate | 先调用 stopLocationUpdate 再重新启动
|
|
9619
|
+
* @errorCode errNo | 1700001 | location permission denied | Android,iOS | 用户拒绝应用位置授权或系统定位权限被拒 | 调用 authorize 重新发起授权并在系统设置中开启定位权限后重试
|
|
9620
|
+
* @errorCode errNo | 1700002 | location network error | Android,iOS | 位置授权过程中发生网络错误 | 检查网络连接后重试
|
|
9621
|
+
* @errorCode errNo | 104 | invalid parameter | iOS | 位置授权 scope 非法 | 检查应用权限声明中配置的 scope 后重试
|
|
9622
|
+
* @platformNote Android | 用户拒绝授权返回 1700001、取消返回 114、授权网络失败返回 1700002;宿主未注册持续定位能力返回 103;其他失败统一返回 102。
|
|
9623
|
+
* @platformNote iOS | 用户拒绝授权返回 1700001、取消返回 114、授权网络失败返回 1700002、非法 scope 返回 104;宿主未注册持续定位能力返回 103;其他失败统一返回 102。
|
|
9280
9624
|
*
|
|
9281
9625
|
* @public
|
|
9282
9626
|
*/
|
|
@@ -9319,7 +9663,16 @@ export declare interface StartLocationUpdateParams {
|
|
|
9319
9663
|
* ```json
|
|
9320
9664
|
* {}
|
|
9321
9665
|
* ```
|
|
9322
|
-
* @
|
|
9666
|
+
* @errorExample
|
|
9667
|
+
* ```json
|
|
9668
|
+
* {
|
|
9669
|
+
* "errNo": 103,
|
|
9670
|
+
* "errMsg": "feature not support"
|
|
9671
|
+
* }
|
|
9672
|
+
* ```
|
|
9673
|
+
* @errorCode common | 102 | Android
|
|
9674
|
+
* @errorCode errNo | 103 | feature not support | Android | 设备无可用的 Wi-Fi 能力(缺少系统 Wi-Fi 服务) | 检查设备是否支持 Wi-Fi,不支持时不要调用
|
|
9675
|
+
* @platformNote iOS | 初始化恒返回成功,不返回失败错误码。
|
|
9323
9676
|
*
|
|
9324
9677
|
* @public
|
|
9325
9678
|
*/
|
|
@@ -9569,7 +9922,16 @@ export declare const stopGyroscope: (params?: {} | undefined) => Promise<object>
|
|
|
9569
9922
|
* ```json
|
|
9570
9923
|
* {}
|
|
9571
9924
|
* ```
|
|
9572
|
-
* @
|
|
9925
|
+
* @errorExample
|
|
9926
|
+
* ```json
|
|
9927
|
+
* {
|
|
9928
|
+
* "errNo": 103,
|
|
9929
|
+
* "errMsg": "feature not support"
|
|
9930
|
+
* }
|
|
9931
|
+
* ```
|
|
9932
|
+
* @errorCode common | 102 | Android,iOS
|
|
9933
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 持续定位已启动,但宿主未注册持续定位能力(location service 不可用),无法停止 | 确认宿主已集成持续定位能力
|
|
9934
|
+
* @platformNote All | 未启动或仍在授权阶段调用直接返回成功;仅在已启动后停止失败时返回错误码,其他失败统一返回 102。
|
|
9573
9935
|
*
|
|
9574
9936
|
* @public
|
|
9575
9937
|
*/
|
|
@@ -9599,7 +9961,7 @@ export declare function stopLocationUpdate(): Promise<LocationOperationResult>;
|
|
|
9599
9961
|
* ```json
|
|
9600
9962
|
* {}
|
|
9601
9963
|
* ```
|
|
9602
|
-
* @errorCode none | - | - | Android,iOS |
|
|
9964
|
+
* @errorCode none | - | - | Android,iOS | 该接口双端恒返回成功,无 API 专属错误码 | 无需处理
|
|
9603
9965
|
*
|
|
9604
9966
|
* @public
|
|
9605
9967
|
*/
|
|
@@ -9839,7 +10201,23 @@ export declare interface UnzipParams {
|
|
|
9839
10201
|
* @precondition Android | 未传 taskId 时需传 entityId;两者都不传时仅可在卡片环境调用,以便客户端补充必要信息。
|
|
9840
10202
|
* @precondition iOS | 未传 taskId 时需传 entityId;两者都不传时仅可在卡片环境调用,以便客户端补充必要信息。
|
|
9841
10203
|
* @usageNote All | 用于在任务或实体维度补充模型可理解的上下文,请在业务状态变化后按需调用,避免高频重复捐赠相同内容。
|
|
9842
|
-
* @
|
|
10204
|
+
* @errorExample
|
|
10205
|
+
* ```json
|
|
10206
|
+
* {
|
|
10207
|
+
* "errNo": 305,
|
|
10208
|
+
* "errMsg": "network failure"
|
|
10209
|
+
* }
|
|
10210
|
+
* ```
|
|
10211
|
+
* @errorCode common | 100 | Android
|
|
10212
|
+
* @errorCode common | 102 | Android
|
|
10213
|
+
* @errorCode errNo | 103 | feature not support | Android | 当前容器类型不受支持,无法归类为页面、卡片或 Worker 来源 | 请在支持的容器(页面、卡片或 Worker)环境中调用。
|
|
10214
|
+
* @errorCode errNo | 112 | invalid result | Android | 捐赠上下文的远端响应无法解析 | 稍后重试;持续失败时反馈服务端响应异常。
|
|
10215
|
+
* @errorCode errNo | 301 | network request cancelled | iOS | 捐赠上下文的网络请求被取消 | 确认应用与网络状态后重试。
|
|
10216
|
+
* @errorCode errNo | 302 | connection timed out | Android,iOS | 捐赠上下文的网络连接超时 | 检查网络连接后重试。
|
|
10217
|
+
* @errorCode errNo | 303 | no network connection | Android,iOS | 当前无可用网络连接 | 恢复网络连接后重试。
|
|
10218
|
+
* @errorCode errNo | 305 | network failure | Android,iOS | 捐赠上下文时发生其他网络错误 | 检查网络连接,稍后重试。
|
|
10219
|
+
* @platformNote Android | 网络失败细分为连接超时 302、无网络 303、其他网络错误 305;远端响应无法解析返回 112;当前容器类型不受支持返回 103;其他失败统一返回 102,未归类的远端业务错误返回 100。
|
|
10220
|
+
* @platformNote iOS | 依据网络错误细分:请求取消 301、连接超时 302、无网络 303、其他 305;不支持的调用来源仅回退处理、不作为失败。
|
|
9843
10221
|
*
|
|
9844
10222
|
* @public
|
|
9845
10223
|
*/
|
|
@@ -9896,7 +10274,18 @@ export declare interface UpdateModelContextParams {
|
|
|
9896
10274
|
* @precondition Android | 在卡片或消息环境中调用,需传入有效的 widgetInstanceId。
|
|
9897
10275
|
* @precondition iOS | 在卡片或消息环境中调用,需传入有效的 widgetInstanceId。
|
|
9898
10276
|
* @usageNote All | 请在卡片交互或服务端结果回写后调用;传入的 widgetData 通常为 `JSON.stringify(viewData)`。
|
|
9899
|
-
* @
|
|
10277
|
+
* @errorExample
|
|
10278
|
+
* ```json
|
|
10279
|
+
* {
|
|
10280
|
+
* "errNo": 104,
|
|
10281
|
+
* "errMsg": "invalid parameter"
|
|
10282
|
+
* }
|
|
10283
|
+
* ```
|
|
10284
|
+
* @errorCode common | 102 | Android,iOS
|
|
10285
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | 当前运行环境未接入消息更新能力(宿主消息依赖或消息服务缺失) | 请在支持卡片消息更新的豆包环境中调用。
|
|
10286
|
+
* @errorCode errNo | 104 | invalid parameter | Android,iOS | widgetInstanceId 或 widgetData 为空,或传入了空字符串的 widgetId | 传入非空的 widgetInstanceId、widgetData,并确保 widgetId 有效后重试。
|
|
10287
|
+
* @errorCode errNo | 116 | resource not found | Android,iOS | 依据 widgetInstanceId 找不到对应消息,或依据 widgetId 找不到已注册的 Widget | 确认 widgetInstanceId 与 widgetId 有效后重试。
|
|
10288
|
+
* @platformNote All | 参数为空返回 104;消息或 Widget 未找到返回 116;宿主消息依赖或消息服务缺失返回 103;其他失败统一返回 102。
|
|
9900
10289
|
*
|
|
9901
10290
|
* @public
|
|
9902
10291
|
*/
|
|
@@ -10183,7 +10572,16 @@ export declare type UserScreenRecordState = 'start' | 'stop';
|
|
|
10183
10572
|
* ```json
|
|
10184
10573
|
* {}
|
|
10185
10574
|
* ```
|
|
10186
|
-
* @
|
|
10575
|
+
* @errorExample
|
|
10576
|
+
* ```json
|
|
10577
|
+
* {
|
|
10578
|
+
* "errNo": 103,
|
|
10579
|
+
* "errMsg": "feature not support"
|
|
10580
|
+
* }
|
|
10581
|
+
* ```
|
|
10582
|
+
* @errorCode errNo | 103 | feature not support | Android | Android 设备无振动器或不支持震动能力 | 提示用户当前设备不支持震动,避免依赖该能力
|
|
10583
|
+
* @errorCode common | 102 | Android
|
|
10584
|
+
* @platformNote iOS | 长震动恒返回成功,无失败错误码
|
|
10187
10585
|
*
|
|
10188
10586
|
* @public
|
|
10189
10587
|
*/
|
|
@@ -10214,7 +10612,16 @@ export declare const vibrateLong: (params?: {} | undefined) => Promise<object>;
|
|
|
10214
10612
|
* ```json
|
|
10215
10613
|
* {}
|
|
10216
10614
|
* ```
|
|
10217
|
-
* @
|
|
10615
|
+
* @errorExample
|
|
10616
|
+
* ```json
|
|
10617
|
+
* {
|
|
10618
|
+
* "errNo": 103,
|
|
10619
|
+
* "errMsg": "feature not support"
|
|
10620
|
+
* }
|
|
10621
|
+
* ```
|
|
10622
|
+
* @errorCode errNo | 103 | feature not support | Android,iOS | Android 设备无振动器或不支持震动能力,或 iOS 系统版本低于 13.0 | 提示用户当前设备或系统不支持震动,避免依赖该能力
|
|
10623
|
+
* @errorCode common | 102 | Android
|
|
10624
|
+
* @platformNote Android | 设备不支持震动或触发震动失败时返回 102 internal error;iOS 无对应失败错误码
|
|
10218
10625
|
*
|
|
10219
10626
|
* @public
|
|
10220
10627
|
*/
|
package/dist/config.d.ts
CHANGED
package/dist/index.d.ts
CHANGED