@doubao-apps/create 0.0.30 → 0.0.31

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.
@@ -408,6 +408,49 @@ socketTask.onError((event) => {
408
408
 
409
409
  ***
410
410
 
411
+ ### createTask()
412
+
413
+ > **createTask**(`params`): `Promise`\<[`CreateTaskResult`](doubao-apps-sdk-open-api.md#createtaskresult)\>
414
+
415
+ 创建任务。
416
+
417
+ #### Parameters
418
+
419
+ • **params**: [`CreateTaskParams`](doubao-apps-sdk-open-api.md#createtaskparams)
420
+
421
+ 任务创建参数。
422
+
423
+ #### Returns
424
+
425
+ `Promise`\<[`CreateTaskResult`](doubao-apps-sdk-open-api.md#createtaskresult)\>
426
+
427
+ 返回创建后的任务 ID、远端任务 token 和过期时间。
428
+
429
+ #### Remarks
430
+
431
+ 创建任务时需要传入开发者侧唯一任务标识、任务模板、任务详情和任务类型。开发者侧唯一任务标识
432
+ 可用于幂等创建和后续业务关联。远端任务创建成功后,返回的 taskId 可用于查询或更新任务。
433
+
434
+ #### Example
435
+
436
+ ```typescript
437
+ import { createTask } from '@doubao-apps/framework/api';
438
+
439
+ const result = await createTask({
440
+ outTaskId: 'order-20260529-001',
441
+ taskTemplate: 'remote_normal_v1',
442
+ taskType: 'remote',
443
+ taskDetail: JSON.stringify({
444
+ title: '订单处理中',
445
+ description: '正在为你处理订单,请稍候'
446
+ })
447
+ });
448
+
449
+ console.log(result.taskId, result.token, result.expiresIn);
450
+ ```
451
+
452
+ ***
453
+
411
454
  ### disableAlertBeforeUnload()
412
455
 
413
456
  > **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
@@ -812,6 +855,18 @@ console.log(result.host?.appId, result.enableDebug);
812
855
 
813
856
  ***
814
857
 
858
+ ### getFileSystemManager()
859
+
860
+ > **getFileSystemManager**(): [`FileSystemManager`](doubao-apps-sdk-open-api.md#filesystemmanager)
861
+
862
+ 获取文件系统管理器
863
+
864
+ #### Returns
865
+
866
+ [`FileSystemManager`](doubao-apps-sdk-open-api.md#filesystemmanager)
867
+
868
+ ***
869
+
815
870
  ### getImageInfo()
816
871
 
817
872
  > **getImageInfo**(`params`): `Promise`\<[`GetImageInfoResult`](doubao-apps-sdk-open-api.md#getimageinforesult)\>
@@ -1221,6 +1276,42 @@ console.log(result.wifiEnabled, result.deviceOrientation);
1221
1276
 
1222
1277
  ***
1223
1278
 
1279
+ ### getTask()
1280
+
1281
+ > **getTask**(`params`): `Promise`\<[`GetTaskResult`](doubao-apps-sdk-open-api.md#gettaskresult)\>
1282
+
1283
+ 查询任务。
1284
+
1285
+ #### Parameters
1286
+
1287
+ • **params**: [`GetTaskParams`](doubao-apps-sdk-open-api.md#gettaskparams)
1288
+
1289
+ 任务查询参数。
1290
+
1291
+ #### Returns
1292
+
1293
+ `Promise`\<[`GetTaskResult`](doubao-apps-sdk-open-api.md#gettaskresult)\>
1294
+
1295
+ 返回任务详情、状态、类型和 token 信息。
1296
+
1297
+ #### Remarks
1298
+
1299
+ 根据任务 ID 查询任务的模板、详情、状态和类型。若返回 token,可在后续远端任务更新中继续使用。
1300
+
1301
+ #### Example
1302
+
1303
+ ```typescript
1304
+ import { getTask } from '@doubao-apps/framework/api';
1305
+
1306
+ const task = await getTask({ taskId: 'task_123' });
1307
+
1308
+ if (task.taskStatus === 'running') {
1309
+ console.log('任务仍在运行', task.taskDetail);
1310
+ }
1311
+ ```
1312
+
1313
+ ***
1314
+
1224
1315
  ### getWifiList()
1225
1316
 
1226
1317
  > **getWifiList**(`params`?): `Promise`\<[`GetWifiListResult`](doubao-apps-sdk-open-api.md#getwifilistresult)\>
@@ -1763,6 +1854,40 @@ off();
1763
1854
 
1764
1855
  ***
1765
1856
 
1857
+ ### onWifiConnected()
1858
+
1859
+ > **onWifiConnected**(`handler`): () => `void`
1860
+
1861
+ 监听连接上 Wi-Fi 的事件。
1862
+
1863
+ #### Parameters
1864
+
1865
+ • **handler**
1866
+
1867
+ #### Returns
1868
+
1869
+ `Function`
1870
+
1871
+ 返回取消当前监听函数的函数。
1872
+
1873
+ ##### Returns
1874
+
1875
+ `void`
1876
+
1877
+ #### Example
1878
+
1879
+ ```ts
1880
+ import { onWifiConnected } from '@doubao-apps/framework/api';
1881
+
1882
+ const off = onWifiConnected(({ wifi }) => {
1883
+ console.log(wifi.ssid);
1884
+ });
1885
+
1886
+ off();
1887
+ ```
1888
+
1889
+ ***
1890
+
1766
1891
  ### openApp()
1767
1892
 
1768
1893
  > **openApp**(`params`): `Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
@@ -2340,7 +2465,7 @@ setStorageSync({
2340
2465
 
2341
2466
  > **setWifiList**(`params`): `Promise`\<`object`\>
2342
2467
 
2343
- 设置 Wi-Fi 预设列表。
2468
+ 设置 Wi-Fi 预设列表(iOS 特有)。
2344
2469
 
2345
2470
  #### Parameters
2346
2471
 
@@ -2352,7 +2477,7 @@ setStorageSync({
2352
2477
 
2353
2478
  #### Remarks
2354
2479
 
2355
- 用于预设 Wi-Fi 列表。
2480
+ 该接口为 iOS 特有,用于预设 Wi-Fi 列表。
2356
2481
 
2357
2482
  ***
2358
2483
 
@@ -2777,6 +2902,48 @@ Wi-Fi 流程入口。
2777
2902
 
2778
2903
  ***
2779
2904
 
2905
+ ### updateTask()
2906
+
2907
+ > **updateTask**(`params`): `Promise`\<[`UpdateTaskResult`](doubao-apps-sdk-open-api.md#updatetaskresult)\>
2908
+
2909
+ 更新任务状态或任务详情。
2910
+
2911
+ #### Parameters
2912
+
2913
+ • **params**: [`UpdateTaskParams`](doubao-apps-sdk-open-api.md#updatetaskparams)
2914
+
2915
+ 任务更新参数,taskStatus 与 taskDetail 二选一。
2916
+
2917
+ #### Returns
2918
+
2919
+ `Promise`\<[`UpdateTaskResult`](doubao-apps-sdk-open-api.md#updatetaskresult)\>
2920
+
2921
+ 返回任务 ID、新 token 和过期时间。
2922
+
2923
+ #### Remarks
2924
+
2925
+ 更新任务时至少传入 taskStatus 或 taskDetail 中的一个。更新远端任务成功后,旧 token 会失效,
2926
+ 如返回 nextToken,后续需要使用新的 token 继续更新远端任务。
2927
+
2928
+ #### Example
2929
+
2930
+ ```typescript
2931
+ import { updateTask } from '@doubao-apps/framework/api';
2932
+
2933
+ const result = await updateTask({
2934
+ taskId: 'task_123',
2935
+ taskStatus: 'completed',
2936
+ taskDetail: JSON.stringify({
2937
+ title: '订单已完成',
2938
+ description: '订单处理完成'
2939
+ })
2940
+ });
2941
+
2942
+ console.log(result.taskId, result.nextToken, result.expiresIn);
2943
+ ```
2944
+
2945
+ ***
2946
+
2780
2947
  ### updateWidget()
2781
2948
 
2782
2949
  > **updateWidget**(`params`): `Promise`\<`object`\>
@@ -2903,6 +3070,20 @@ Z 轴加速度,单位 m/s²。
2903
3070
 
2904
3071
  ***
2905
3072
 
3073
+ ### AccessParams
3074
+
3075
+ [FileSystemManager.access](doubao-apps-sdk-open-api.md#access) 的参数。
3076
+
3077
+ #### Properties
3078
+
3079
+ ##### path
3080
+
3081
+ > **path**: `string`
3082
+
3083
+ 要判断是否存在的文件或目录路径。
3084
+
3085
+ ***
3086
+
2906
3087
  ### AddPhoneCalendarParams
2907
3088
 
2908
3089
  添加系统日历事件的请求参数。
@@ -3279,6 +3460,46 @@ Z 轴加速度,单位 m/s²。
3279
3460
 
3280
3461
  ***
3281
3462
 
3463
+ ### AppendFileParams
3464
+
3465
+ [FileSystemManager.appendFile](doubao-apps-sdk-open-api.md#appendfile) 的参数。
3466
+
3467
+ #### Remarks
3468
+
3469
+ - 如果文件不存在会自动创建。
3470
+ - 与 [WriteFileParams](doubao-apps-sdk-open-api.md#writefileparams) 不同,追加写入不会覆盖文件已有内容,而是在末尾追加。
3471
+
3472
+ #### Properties
3473
+
3474
+ ##### data
3475
+
3476
+ > **data**: `string`
3477
+
3478
+ 要追加的内容。
3479
+
3480
+ - 当 `encoding` 为 `'utf-8'` 时,直接追加该字符串;
3481
+ - 当 `encoding` 为 `'base64'` 时,将该字符串先进行 Base64 解码再追加到文件末尾。
3482
+
3483
+ ##### encoding?
3484
+
3485
+ > `optional` **encoding**: `"base64"` \| `"utf-8"`
3486
+
3487
+ 指定写入文件的字符编码。
3488
+
3489
+ ###### Default
3490
+
3491
+ ```ts
3492
+ 'utf-8'
3493
+ ```
3494
+
3495
+ ##### filePath
3496
+
3497
+ > **filePath**: `string`
3498
+
3499
+ 要追加内容的文件路径(本地路径)。
3500
+
3501
+ ***
3502
+
3282
3503
  ### AuthorizeRequest
3283
3504
 
3284
3505
  #### Properties
@@ -3903,6 +4124,31 @@ Wi-Fi SSID。
3903
4124
 
3904
4125
  ***
3905
4126
 
4127
+ ### CopyFileParams
4128
+
4129
+ [FileSystemManager.copyFile](doubao-apps-sdk-open-api.md#copyfile) 的参数。
4130
+
4131
+ #### Remarks
4132
+
4133
+ - 不支持复制目录,仅支持复制文件。
4134
+ - 如果目标路径已存在同名文件,会被覆盖。
4135
+
4136
+ #### Properties
4137
+
4138
+ ##### destPath
4139
+
4140
+ > **destPath**: `string`
4141
+
4142
+ 目标文件路径(复制后生成的文件)。
4143
+
4144
+ ##### srcPath
4145
+
4146
+ > **srcPath**: `string`
4147
+
4148
+ 源文件路径(被复制的文件)。
4149
+
4150
+ ***
4151
+
3906
4152
  ### CreateBLEConnectionParams
3907
4153
 
3908
4154
  创建 BLE 连接的请求参数。
@@ -3983,6 +4229,64 @@ Wi-Fi SSID。
3983
4229
 
3984
4230
  ***
3985
4231
 
4232
+ ### CreateTaskParams
4233
+
4234
+ 创建任务的请求参数。
4235
+
4236
+ #### Properties
4237
+
4238
+ ##### outTaskId
4239
+
4240
+ > **outTaskId**: `string`
4241
+
4242
+ 开发者侧任务唯一标识,用于幂等和关联
4243
+
4244
+ ##### taskDetail
4245
+
4246
+ > **taskDetail**: `string`
4247
+
4248
+ 模板对应的数据的 JSON 字符串
4249
+
4250
+ ##### taskTemplate
4251
+
4252
+ > **taskTemplate**: `"remote_normal_v1"`
4253
+
4254
+ 任务样式模板,当前仅支持 remote_normal_v1
4255
+
4256
+ ##### taskType
4257
+
4258
+ > **taskType**: [`TaskType`](doubao-apps-sdk-open-api.md#tasktype-2)
4259
+
4260
+ 任务类型,当前支持 local 和 remote
4261
+
4262
+ ***
4263
+
4264
+ ### CreateTaskResult
4265
+
4266
+ 创建任务的返回结果。
4267
+
4268
+ #### Properties
4269
+
4270
+ ##### expiresIn?
4271
+
4272
+ > `optional` **expiresIn**: `number`
4273
+
4274
+ 任务超时过期时间
4275
+
4276
+ ##### taskId
4277
+
4278
+ > **taskId**: `string`
4279
+
4280
+ 任务 ID,后续可以使用这个 ID 更新任务
4281
+
4282
+ ##### token?
4283
+
4284
+ > `optional` **token**: `string`
4285
+
4286
+ 远端任务 token,后续使用 token 通过 OpenAPI 更新远端任务
4287
+
4288
+ ***
4289
+
3986
4290
  ### DeviceMotionChangeEvent
3987
4291
 
3988
4292
  设备方向变化事件。
@@ -4146,103 +4450,618 @@ mcp入参,如果expectedAction里预期要调用工具,需要在这里写明
4146
4450
 
4147
4451
  ***
4148
4452
 
4149
- ### GetAccountInfoResult
4453
+ ### FileSystemManager
4150
4454
 
4151
- 获取当前账号信息。
4455
+ 文件系统管理器,提供对本地文件系统的完整读写能力。
4152
4456
 
4153
- #### Properties
4457
+ 通过 [getFileSystemManager](doubao-apps-sdk-open-api.md#getfilesystemmanager) 获取实例后,可使用该接口上的方法执行文件和目录操作。
4458
+ 大多数方法同时提供异步(返回 `Promise`)和同步(`Sync` 后缀)两种调用方式。
4154
4459
 
4155
- ##### miniProgram
4460
+ #### Remarks
4156
4461
 
4157
- > **miniProgram**: [`DoubaoAppAccountInfo`](doubao-apps-sdk-open-api.md#doubaoappaccountinfo)
4462
+ - 所有路径参数均为本地文件路径,不支持网络路径。
4463
+ - 同步方法会阻塞当前 JS 线程直到操作完成;对于大文件操作建议使用异步方法以避免卡顿。
4464
+ - 文件操作失败时(如路径不存在、权限不足),Promise 会被 reject 或同步方法会抛出异常。
4158
4465
 
4159
- 豆包 App账号信息
4466
+ #### Methods
4160
4467
 
4161
- ##### plugin?
4468
+ ##### access()
4162
4469
 
4163
- > `optional` **plugin**: [`PluginAccountInfo`](doubao-apps-sdk-open-api.md#pluginaccountinfo)
4470
+ > **access**(`params`): `Promise`\<`void`\>
4164
4471
 
4165
- 插件账号信息(仅在插件中调用时包含)
4472
+ 判断文件或目录是否存在(异步)。
4166
4473
 
4167
- ***
4474
+ 路径存在时 Promise resolve;路径不存在时 Promise reject。
4168
4475
 
4169
- ### GetAppBaseInfoResult
4476
+ ###### Parameters
4170
4477
 
4171
- #### Properties
4478
+ **params**: [`AccessParams`](doubao-apps-sdk-open-api.md#accessparams)
4172
4479
 
4173
- ##### SDKVersion?
4480
+ 参见 [AccessParams](doubao-apps-sdk-open-api.md#accessparams)。
4174
4481
 
4175
- > `optional` **SDKVersion**: `string`
4482
+ ###### Returns
4176
4483
 
4177
- 客户端基础库版本
4484
+ `Promise`\<`void`\>
4178
4485
 
4179
- ##### enableDebug?
4486
+ ##### accessSync()
4180
4487
 
4181
- > `optional` **enableDebug**: `boolean`
4488
+ > **accessSync**(`params`): `void`
4182
4489
 
4183
- 是否已打开调试
4490
+ 判断文件或目录是否存在(同步)。
4184
4491
 
4185
- ##### host?
4492
+ 路径不存在时会抛出异常。
4186
4493
 
4187
- > `optional` **host**: [`AppBaseInfoHost`](doubao-apps-sdk-open-api.md#appbaseinfohost)
4494
+ ###### Parameters
4188
4495
 
4189
- 当前豆包 App运行的宿主环境
4496
+ **params**: [`AccessParams`](doubao-apps-sdk-open-api.md#accessparams)
4190
4497
 
4191
- ##### language
4498
+ 参见 [AccessParams](doubao-apps-sdk-open-api.md#accessparams)。
4192
4499
 
4193
- > **language**: `string`
4500
+ ###### Returns
4194
4501
 
4195
- 当前语言
4502
+ `void`
4196
4503
 
4197
- ##### theme?
4504
+ ##### appendFile()
4198
4505
 
4199
- > `optional` **theme**: `"light"` \| `"dark"`
4506
+ > **appendFile**(`params`): `Promise`\<`void`\>
4200
4507
 
4201
- 当前主题
4508
+ 在文件末尾追加内容(异步)。如果文件不存在则创建。
4202
4509
 
4203
- ##### version?
4510
+ ###### Parameters
4204
4511
 
4205
- > `optional` **version**: `string`
4512
+ **params**: [`AppendFileParams`](doubao-apps-sdk-open-api.md#appendfileparams)
4206
4513
 
4207
- 宿主版本号
4514
+ 追加参数,参见 [AppendFileParams](doubao-apps-sdk-open-api.md#appendfileparams)。
4208
4515
 
4209
- ***
4516
+ ###### Returns
4210
4517
 
4211
- ### GetBLEDeviceCharacteristicsParams
4518
+ `Promise`\<`void`\>
4212
4519
 
4213
- 获取 BLE 特征值列表的请求参数。
4520
+ ##### appendFileSync()
4214
4521
 
4215
- #### Properties
4522
+ > **appendFileSync**(`params`): `void`
4216
4523
 
4217
- ##### deviceId
4524
+ 在文件末尾追加内容(同步)。如果文件不存在则创建。
4218
4525
 
4219
- > **deviceId**: `string`
4526
+ ###### Parameters
4220
4527
 
4221
- 蓝牙设备 ID。
4528
+ **params**: [`AppendFileParams`](doubao-apps-sdk-open-api.md#appendfileparams)
4222
4529
 
4223
- ##### serviceId
4530
+ 追加参数,参见 [AppendFileParams](doubao-apps-sdk-open-api.md#appendfileparams)。
4224
4531
 
4225
- > **serviceId**: `string`
4532
+ ###### Returns
4226
4533
 
4227
- 服务 ID。
4534
+ `void`
4228
4535
 
4229
- ***
4536
+ ##### copyFile()
4230
4537
 
4231
- ### GetBLEDeviceCharacteristicsResult
4538
+ > **copyFile**(`params`): `Promise`\<`void`\>
4232
4539
 
4233
- 获取 BLE 特征值列表的返回结果。
4540
+ 复制文件(异步)。不支持复制目录。
4234
4541
 
4235
- #### Properties
4542
+ ###### Parameters
4236
4543
 
4237
- ##### characteristics
4544
+ **params**: [`CopyFileParams`](doubao-apps-sdk-open-api.md#copyfileparams)
4238
4545
 
4239
- > **characteristics**: [`BluetoothCharacteristic`](doubao-apps-sdk-open-api.md#bluetoothcharacteristic)[]
4546
+ 参见 [CopyFileParams](doubao-apps-sdk-open-api.md#copyfileparams)
4240
4547
 
4241
- 特征值列表。
4548
+ ###### Returns
4242
4549
 
4243
- ***
4550
+ `Promise`\<`void`\>
4244
4551
 
4245
- ### GetBLEDeviceRSSIParams
4552
+ ##### copyFileSync()
4553
+
4554
+ > **copyFileSync**(`params`): `void`
4555
+
4556
+ 复制文件(同步)。不支持复制目录。
4557
+
4558
+ ###### Parameters
4559
+
4560
+ • **params**: [`CopyFileParams`](doubao-apps-sdk-open-api.md#copyfileparams)
4561
+
4562
+ 参见 [CopyFileParams](doubao-apps-sdk-open-api.md#copyfileparams)。
4563
+
4564
+ ###### Returns
4565
+
4566
+ `void`
4567
+
4568
+ ##### getFileInfo()
4569
+
4570
+ > **getFileInfo**(`params`): `Promise`\<[`GetFileInfoResult`](doubao-apps-sdk-open-api.md#getfileinforesult)\>
4571
+
4572
+ 获取文件信息,可选计算文件摘要(异步)。
4573
+
4574
+ ###### Parameters
4575
+
4576
+ • **params**: [`GetFileInfoParams`](doubao-apps-sdk-open-api.md#getfileinfoparams)
4577
+
4578
+ 参见 [GetFileInfoParams](doubao-apps-sdk-open-api.md#getfileinfoparams)。
4579
+
4580
+ ###### Returns
4581
+
4582
+ `Promise`\<[`GetFileInfoResult`](doubao-apps-sdk-open-api.md#getfileinforesult)\>
4583
+
4584
+ 返回一个 Promise,解析为 [GetFileInfoResult](doubao-apps-sdk-open-api.md#getfileinforesult)。
4585
+
4586
+ ##### getSavedFileList()
4587
+
4588
+ > **getSavedFileList**(): `Promise`\<[`GetSavedFileListResult`](doubao-apps-sdk-open-api.md#getsavedfilelistresult)\>
4589
+
4590
+ 获取已保存的本地文件列表(异步)。
4591
+
4592
+ ###### Returns
4593
+
4594
+ `Promise`\<[`GetSavedFileListResult`](doubao-apps-sdk-open-api.md#getsavedfilelistresult)\>
4595
+
4596
+ 返回一个 Promise,解析为 [GetSavedFileListResult](doubao-apps-sdk-open-api.md#getsavedfilelistresult)。
4597
+
4598
+ ##### mkdir()
4599
+
4600
+ > **mkdir**(`params`): `Promise`\<`void`\>
4601
+
4602
+ 创建目录(异步)。
4603
+
4604
+ ###### Parameters
4605
+
4606
+ • **params**: [`MkdirParams`](doubao-apps-sdk-open-api.md#mkdirparams)
4607
+
4608
+ 参见 [MkdirParams](doubao-apps-sdk-open-api.md#mkdirparams)。
4609
+
4610
+ ###### Returns
4611
+
4612
+ `Promise`\<`void`\>
4613
+
4614
+ ##### mkdirSync()
4615
+
4616
+ > **mkdirSync**(`params`): `void`
4617
+
4618
+ 创建目录(同步)。
4619
+
4620
+ ###### Parameters
4621
+
4622
+ • **params**: [`MkdirParams`](doubao-apps-sdk-open-api.md#mkdirparams)
4623
+
4624
+ 参见 [MkdirParams](doubao-apps-sdk-open-api.md#mkdirparams)。
4625
+
4626
+ ###### Returns
4627
+
4628
+ `void`
4629
+
4630
+ ##### readFile()
4631
+
4632
+ > **readFile**(`params`): `Promise`\<[`ReadFileResult`](doubao-apps-sdk-open-api.md#readfileresult)\>
4633
+
4634
+ 读取文件内容(异步)。
4635
+
4636
+ ###### Parameters
4637
+
4638
+ • **params**: [`ReadFileParams`](doubao-apps-sdk-open-api.md#readfileparams)
4639
+
4640
+ 读取参数,参见 [ReadFileParams](doubao-apps-sdk-open-api.md#readfileparams)。
4641
+
4642
+ ###### Returns
4643
+
4644
+ `Promise`\<[`ReadFileResult`](doubao-apps-sdk-open-api.md#readfileresult)\>
4645
+
4646
+ 返回一个 Promise,解析为 [ReadFileResult](doubao-apps-sdk-open-api.md#readfileresult)。
4647
+
4648
+ ##### readFileSync()
4649
+
4650
+ > **readFileSync**(`params`): [`ReadFileResult`](doubao-apps-sdk-open-api.md#readfileresult)
4651
+
4652
+ 读取文件内容(同步)。
4653
+
4654
+ ###### Parameters
4655
+
4656
+ • **params**: [`ReadFileParams`](doubao-apps-sdk-open-api.md#readfileparams)
4657
+
4658
+ 读取参数,参见 [ReadFileParams](doubao-apps-sdk-open-api.md#readfileparams)。
4659
+
4660
+ ###### Returns
4661
+
4662
+ [`ReadFileResult`](doubao-apps-sdk-open-api.md#readfileresult)
4663
+
4664
+ 返回 [ReadFileResult](doubao-apps-sdk-open-api.md#readfileresult)。
4665
+
4666
+ ##### readdir()
4667
+
4668
+ > **readdir**(`params`): `Promise`\<[`ReaddirResult`](doubao-apps-sdk-open-api.md#readdirresult)\>
4669
+
4670
+ 读取目录下的文件和子目录列表(异步)。
4671
+
4672
+ ###### Parameters
4673
+
4674
+ • **params**: [`ReaddirParams`](doubao-apps-sdk-open-api.md#readdirparams)
4675
+
4676
+ 参见 [ReaddirParams](doubao-apps-sdk-open-api.md#readdirparams)。
4677
+
4678
+ ###### Returns
4679
+
4680
+ `Promise`\<[`ReaddirResult`](doubao-apps-sdk-open-api.md#readdirresult)\>
4681
+
4682
+ 返回一个 Promise,解析为 [ReaddirResult](doubao-apps-sdk-open-api.md#readdirresult)。
4683
+
4684
+ ##### readdirSync()
4685
+
4686
+ > **readdirSync**(`params`): [`ReaddirResult`](doubao-apps-sdk-open-api.md#readdirresult)
4687
+
4688
+ 读取目录下的文件和子目录列表(同步)。
4689
+
4690
+ ###### Parameters
4691
+
4692
+ • **params**: [`ReaddirParams`](doubao-apps-sdk-open-api.md#readdirparams)
4693
+
4694
+ 参见 [ReaddirParams](doubao-apps-sdk-open-api.md#readdirparams)。
4695
+
4696
+ ###### Returns
4697
+
4698
+ [`ReaddirResult`](doubao-apps-sdk-open-api.md#readdirresult)
4699
+
4700
+ 返回 [ReaddirResult](doubao-apps-sdk-open-api.md#readdirresult)。
4701
+
4702
+ ##### removeSavedFile()
4703
+
4704
+ > **removeSavedFile**(`params`): `Promise`\<`void`\>
4705
+
4706
+ 删除通过 [FileSystemManager.saveFile](doubao-apps-sdk-open-api.md#savefile) 保存的本地文件(异步)。
4707
+
4708
+ ###### Parameters
4709
+
4710
+ • **params**: [`RemoveSavedFileParams`](doubao-apps-sdk-open-api.md#removesavedfileparams)
4711
+
4712
+ 参见 [RemoveSavedFileParams](doubao-apps-sdk-open-api.md#removesavedfileparams)。
4713
+
4714
+ ###### Returns
4715
+
4716
+ `Promise`\<`void`\>
4717
+
4718
+ ##### rename()
4719
+
4720
+ > **rename**(`params`): `Promise`\<`void`\>
4721
+
4722
+ 重命名或移动文件(异步)。
4723
+
4724
+ ###### Parameters
4725
+
4726
+ • **params**: [`RenameParams`](doubao-apps-sdk-open-api.md#renameparams)
4727
+
4728
+ 参见 [RenameParams](doubao-apps-sdk-open-api.md#renameparams)。
4729
+
4730
+ ###### Returns
4731
+
4732
+ `Promise`\<`void`\>
4733
+
4734
+ ##### renameSync()
4735
+
4736
+ > **renameSync**(`params`): `void`
4737
+
4738
+ 重命名或移动文件(同步)。
4739
+
4740
+ ###### Parameters
4741
+
4742
+ • **params**: [`RenameParams`](doubao-apps-sdk-open-api.md#renameparams)
4743
+
4744
+ 参见 [RenameParams](doubao-apps-sdk-open-api.md#renameparams)。
4745
+
4746
+ ###### Returns
4747
+
4748
+ `void`
4749
+
4750
+ ##### rmdir()
4751
+
4752
+ > **rmdir**(`params`): `Promise`\<`void`\>
4753
+
4754
+ 删除目录(异步)。
4755
+
4756
+ ###### Parameters
4757
+
4758
+ • **params**: [`RmdirParams`](doubao-apps-sdk-open-api.md#rmdirparams)
4759
+
4760
+ 参见 [RmdirParams](doubao-apps-sdk-open-api.md#rmdirparams)。
4761
+
4762
+ ###### Returns
4763
+
4764
+ `Promise`\<`void`\>
4765
+
4766
+ ##### rmdirSync()
4767
+
4768
+ > **rmdirSync**(`params`): `void`
4769
+
4770
+ 删除目录(同步)。
4771
+
4772
+ ###### Parameters
4773
+
4774
+ • **params**: [`RmdirParams`](doubao-apps-sdk-open-api.md#rmdirparams)
4775
+
4776
+ 参见 [RmdirParams](doubao-apps-sdk-open-api.md#rmdirparams)。
4777
+
4778
+ ###### Returns
4779
+
4780
+ `void`
4781
+
4782
+ ##### saveFile()
4783
+
4784
+ > **saveFile**(`params`): `Promise`\<[`SaveFileResult`](doubao-apps-sdk-open-api.md#savefileresult)\>
4785
+
4786
+ 将临时文件保存到本地持久化存储(异步)。
4787
+
4788
+ ###### Parameters
4789
+
4790
+ • **params**: [`SaveFileParams`](doubao-apps-sdk-open-api.md#savefileparams)
4791
+
4792
+ 参见 [SaveFileParams](doubao-apps-sdk-open-api.md#savefileparams)。
4793
+
4794
+ ###### Returns
4795
+
4796
+ `Promise`\<[`SaveFileResult`](doubao-apps-sdk-open-api.md#savefileresult)\>
4797
+
4798
+ 返回一个 Promise,解析为 [SaveFileResult](doubao-apps-sdk-open-api.md#savefileresult)。
4799
+
4800
+ ##### saveFileSync()
4801
+
4802
+ > **saveFileSync**(`params`): [`SaveFileResult`](doubao-apps-sdk-open-api.md#savefileresult)
4803
+
4804
+ 将临时文件保存到本地持久化存储(同步)。
4805
+
4806
+ ###### Parameters
4807
+
4808
+ • **params**: [`SaveFileParams`](doubao-apps-sdk-open-api.md#savefileparams)
4809
+
4810
+ 参见 [SaveFileParams](doubao-apps-sdk-open-api.md#savefileparams)。
4811
+
4812
+ ###### Returns
4813
+
4814
+ [`SaveFileResult`](doubao-apps-sdk-open-api.md#savefileresult)
4815
+
4816
+ 返回 [SaveFileResult](doubao-apps-sdk-open-api.md#savefileresult)。
4817
+
4818
+ ##### stat()
4819
+
4820
+ > **stat**(`params`): `Promise`\<[`StatResult`](doubao-apps-sdk-open-api.md#statresult)\>
4821
+
4822
+ 获取文件或目录的状态信息(异步)。
4823
+
4824
+ ###### Parameters
4825
+
4826
+ • **params**: [`StatParams`](doubao-apps-sdk-open-api.md#statparams)
4827
+
4828
+ 参见 [StatParams](doubao-apps-sdk-open-api.md#statparams)。
4829
+
4830
+ ###### Returns
4831
+
4832
+ `Promise`\<[`StatResult`](doubao-apps-sdk-open-api.md#statresult)\>
4833
+
4834
+ 返回一个 Promise,解析为 [StatResult](doubao-apps-sdk-open-api.md#statresult)。
4835
+
4836
+ ##### statSync()
4837
+
4838
+ > **statSync**(`params`): [`StatResult`](doubao-apps-sdk-open-api.md#statresult)
4839
+
4840
+ 获取文件或目录的状态信息(同步)。
4841
+
4842
+ ###### Parameters
4843
+
4844
+ • **params**: [`StatParams`](doubao-apps-sdk-open-api.md#statparams)
4845
+
4846
+ 参见 [StatParams](doubao-apps-sdk-open-api.md#statparams)。
4847
+
4848
+ ###### Returns
4849
+
4850
+ [`StatResult`](doubao-apps-sdk-open-api.md#statresult)
4851
+
4852
+ 返回 [StatResult](doubao-apps-sdk-open-api.md#statresult)。
4853
+
4854
+ ##### truncate()
4855
+
4856
+ > **truncate**(`params`): `Promise`\<`void`\>
4857
+
4858
+ 截断文件到指定长度(异步)。
4859
+
4860
+ ###### Parameters
4861
+
4862
+ • **params**: [`TruncateParams`](doubao-apps-sdk-open-api.md#truncateparams)
4863
+
4864
+ 参见 [TruncateParams](doubao-apps-sdk-open-api.md#truncateparams)。
4865
+
4866
+ ###### Returns
4867
+
4868
+ `Promise`\<`void`\>
4869
+
4870
+ ##### truncateSync()
4871
+
4872
+ > **truncateSync**(`params`): `void`
4873
+
4874
+ 截断文件到指定长度(同步)。
4875
+
4876
+ ###### Parameters
4877
+
4878
+ • **params**: [`TruncateParams`](doubao-apps-sdk-open-api.md#truncateparams)
4879
+
4880
+ 参见 [TruncateParams](doubao-apps-sdk-open-api.md#truncateparams)。
4881
+
4882
+ ###### Returns
4883
+
4884
+ `void`
4885
+
4886
+ ##### unlink()
4887
+
4888
+ > **unlink**(`params`): `Promise`\<`void`\>
4889
+
4890
+ 删除文件(异步)。不能用于删除目录。
4891
+
4892
+ ###### Parameters
4893
+
4894
+ • **params**: [`UnlinkParams`](doubao-apps-sdk-open-api.md#unlinkparams)
4895
+
4896
+ 参见 [UnlinkParams](doubao-apps-sdk-open-api.md#unlinkparams)。
4897
+
4898
+ ###### Returns
4899
+
4900
+ `Promise`\<`void`\>
4901
+
4902
+ ##### unlinkSync()
4903
+
4904
+ > **unlinkSync**(`params`): `void`
4905
+
4906
+ 删除文件(同步)。不能用于删除目录。
4907
+
4908
+ ###### Parameters
4909
+
4910
+ • **params**: [`UnlinkParams`](doubao-apps-sdk-open-api.md#unlinkparams)
4911
+
4912
+ 参见 [UnlinkParams](doubao-apps-sdk-open-api.md#unlinkparams)。
4913
+
4914
+ ###### Returns
4915
+
4916
+ `void`
4917
+
4918
+ ##### unzip()
4919
+
4920
+ > **unzip**(`params`): `Promise`\<`void`\>
4921
+
4922
+ 解压 zip 文件到指定目录(异步)。
4923
+
4924
+ ###### Parameters
4925
+
4926
+ • **params**: [`UnzipParams`](doubao-apps-sdk-open-api.md#unzipparams)
4927
+
4928
+ 参见 [UnzipParams](doubao-apps-sdk-open-api.md#unzipparams)。
4929
+
4930
+ ###### Returns
4931
+
4932
+ `Promise`\<`void`\>
4933
+
4934
+ ##### writeFile()
4935
+
4936
+ > **writeFile**(`params`): `Promise`\<`void`\>
4937
+
4938
+ 写入文件内容(异步)。如果文件不存在则创建,已存在则覆盖。
4939
+
4940
+ ###### Parameters
4941
+
4942
+ • **params**: [`WriteFileParams`](doubao-apps-sdk-open-api.md#writefileparams)
4943
+
4944
+ 写入参数,参见 [WriteFileParams](doubao-apps-sdk-open-api.md#writefileparams)。
4945
+
4946
+ ###### Returns
4947
+
4948
+ `Promise`\<`void`\>
4949
+
4950
+ ##### writeFileSync()
4951
+
4952
+ > **writeFileSync**(`params`): `void`
4953
+
4954
+ 写入文件内容(同步)。如果文件不存在则创建,已存在则覆盖。
4955
+
4956
+ ###### Parameters
4957
+
4958
+ • **params**: [`WriteFileParams`](doubao-apps-sdk-open-api.md#writefileparams)
4959
+
4960
+ 写入参数,参见 [WriteFileParams](doubao-apps-sdk-open-api.md#writefileparams)。
4961
+
4962
+ ###### Returns
4963
+
4964
+ `void`
4965
+
4966
+ ***
4967
+
4968
+ ### GetAccountInfoResult
4969
+
4970
+ 获取当前账号信息。
4971
+
4972
+ #### Properties
4973
+
4974
+ ##### miniProgram
4975
+
4976
+ > **miniProgram**: [`DoubaoAppAccountInfo`](doubao-apps-sdk-open-api.md#doubaoappaccountinfo)
4977
+
4978
+ 豆包 App账号信息
4979
+
4980
+ ##### plugin?
4981
+
4982
+ > `optional` **plugin**: [`PluginAccountInfo`](doubao-apps-sdk-open-api.md#pluginaccountinfo)
4983
+
4984
+ 插件账号信息(仅在插件中调用时包含)
4985
+
4986
+ ***
4987
+
4988
+ ### GetAppBaseInfoResult
4989
+
4990
+ #### Properties
4991
+
4992
+ ##### SDKVersion?
4993
+
4994
+ > `optional` **SDKVersion**: `string`
4995
+
4996
+ 客户端基础库版本
4997
+
4998
+ ##### enableDebug?
4999
+
5000
+ > `optional` **enableDebug**: `boolean`
5001
+
5002
+ 是否已打开调试
5003
+
5004
+ ##### host?
5005
+
5006
+ > `optional` **host**: [`AppBaseInfoHost`](doubao-apps-sdk-open-api.md#appbaseinfohost)
5007
+
5008
+ 当前豆包 App运行的宿主环境
5009
+
5010
+ ##### language
5011
+
5012
+ > **language**: `string`
5013
+
5014
+ 当前语言
5015
+
5016
+ ##### theme?
5017
+
5018
+ > `optional` **theme**: `"light"` \| `"dark"`
5019
+
5020
+ 当前主题
5021
+
5022
+ ##### version?
5023
+
5024
+ > `optional` **version**: `string`
5025
+
5026
+ 宿主版本号
5027
+
5028
+ ***
5029
+
5030
+ ### GetBLEDeviceCharacteristicsParams
5031
+
5032
+ 获取 BLE 特征值列表的请求参数。
5033
+
5034
+ #### Properties
5035
+
5036
+ ##### deviceId
5037
+
5038
+ > **deviceId**: `string`
5039
+
5040
+ 蓝牙设备 ID。
5041
+
5042
+ ##### serviceId
5043
+
5044
+ > **serviceId**: `string`
5045
+
5046
+ 服务 ID。
5047
+
5048
+ ***
5049
+
5050
+ ### GetBLEDeviceCharacteristicsResult
5051
+
5052
+ 获取 BLE 特征值列表的返回结果。
5053
+
5054
+ #### Properties
5055
+
5056
+ ##### characteristics
5057
+
5058
+ > **characteristics**: [`BluetoothCharacteristic`](doubao-apps-sdk-open-api.md#bluetoothcharacteristic)[]
5059
+
5060
+ 特征值列表。
5061
+
5062
+ ***
5063
+
5064
+ ### GetBLEDeviceRSSIParams
4246
5065
 
4247
5066
  获取 BLE RSSI 的请求参数。
4248
5067
 
@@ -4470,6 +5289,53 @@ RSSI 信号强度,单位 dBm。
4470
5289
 
4471
5290
  ***
4472
5291
 
5292
+ ### GetFileInfoParams
5293
+
5294
+ [FileSystemManager.getFileInfo](doubao-apps-sdk-open-api.md#getfileinfo) 的参数。
5295
+
5296
+ #### Properties
5297
+
5298
+ ##### digestAlgorithm?
5299
+
5300
+ > `optional` **digestAlgorithm**: `"md5"` \| `"sha1"`
5301
+
5302
+ 用于计算文件摘要的哈希算法。
5303
+
5304
+ - `'md5'`:使用 MD5 算法计算文件摘要。
5305
+ - `'sha1'`:使用 SHA-1 算法计算文件摘要。
5306
+
5307
+ 不传时不计算摘要,返回结果中 [GetFileInfoResult.digest](doubao-apps-sdk-open-api.md#digest) 为 `undefined`。
5308
+
5309
+ ##### filePath
5310
+
5311
+ > **filePath**: `string`
5312
+
5313
+ 要获取信息的文件路径。
5314
+
5315
+ ***
5316
+
5317
+ ### GetFileInfoResult
5318
+
5319
+ [FileSystemManager.getFileInfo](doubao-apps-sdk-open-api.md#getfileinfo) 的返回结果。
5320
+
5321
+ #### Properties
5322
+
5323
+ ##### digest?
5324
+
5325
+ > `optional` **digest**: `string`
5326
+
5327
+ 按照 [GetFileInfoParams.digestAlgorithm](doubao-apps-sdk-open-api.md#digestalgorithm) 计算得到的文件摘要(十六进制字符串)。
5328
+
5329
+ 仅当请求时指定了 `digestAlgorithm` 才会返回。
5330
+
5331
+ ##### size
5332
+
5333
+ > **size**: `number`
5334
+
5335
+ 文件大小,单位为字节(Byte)。
5336
+
5337
+ ***
5338
+
4473
5339
  ### GetImageInfoParams
4474
5340
 
4475
5341
  获取图片信息的请求参数。
@@ -4733,6 +5599,20 @@ RSSI 信号强度,单位 dBm。
4733
5599
 
4734
5600
  ***
4735
5601
 
5602
+ ### GetSavedFileListResult
5603
+
5604
+ [FileSystemManager.getSavedFileList](doubao-apps-sdk-open-api.md#getsavedfilelist) 的返回结果。
5605
+
5606
+ #### Properties
5607
+
5608
+ ##### fileList
5609
+
5610
+ > **fileList**: `object`[]
5611
+
5612
+ 已保存的本地文件列表,每项包含文件路径、大小和创建时间。
5613
+
5614
+ ***
5615
+
4736
5616
  ### GetScreenBrightnessResult
4737
5617
 
4738
5618
  #### Properties
@@ -4847,6 +5727,70 @@ Wi-Fi 的系统开关
4847
5727
 
4848
5728
  ***
4849
5729
 
5730
+ ### GetTaskParams
5731
+
5732
+ 查询任务的请求参数。
5733
+
5734
+ #### Properties
5735
+
5736
+ ##### taskId
5737
+
5738
+ > **taskId**: `string`
5739
+
5740
+ 任务 ID
5741
+
5742
+ ***
5743
+
5744
+ ### GetTaskResult
5745
+
5746
+ 查询任务的返回结果。
5747
+
5748
+ #### Properties
5749
+
5750
+ ##### expiresIn?
5751
+
5752
+ > `optional` **expiresIn**: `number`
5753
+
5754
+ 任务超时过期时间
5755
+
5756
+ ##### taskDetail
5757
+
5758
+ > **taskDetail**: `string`
5759
+
5760
+ 模板对应的数据的 JSON 字符串
5761
+
5762
+ ##### taskId
5763
+
5764
+ > **taskId**: `string`
5765
+
5766
+ 任务 ID
5767
+
5768
+ ##### taskStatus
5769
+
5770
+ > **taskStatus**: [`TaskStatus`](doubao-apps-sdk-open-api.md#taskstatus-2)
5771
+
5772
+ 任务状态,运行中或已完成
5773
+
5774
+ ##### taskTemplate
5775
+
5776
+ > **taskTemplate**: `"remote_normal_v1"`
5777
+
5778
+ 任务样式模板,当前仅支持 remote_normal_v1
5779
+
5780
+ ##### taskType
5781
+
5782
+ > **taskType**: [`TaskType`](doubao-apps-sdk-open-api.md#tasktype-2)
5783
+
5784
+ 任务类型,local 或 remote
5785
+
5786
+ ##### token?
5787
+
5788
+ > `optional` **token**: `string`
5789
+
5790
+ 每次更新后旧的 token 失效,必须使用新返回的 token
5791
+
5792
+ ***
5793
+
4850
5794
  ### GetWifiListResult
4851
5795
 
4852
5796
  获取 Wi-Fi 列表的返回结果。
@@ -5113,6 +6057,34 @@ Whether the login is successful
5113
6057
 
5114
6058
  ***
5115
6059
 
6060
+ ### MkdirParams
6061
+
6062
+ [FileSystemManager.mkdir](doubao-apps-sdk-open-api.md#mkdir) 的参数。
6063
+
6064
+ #### Properties
6065
+
6066
+ ##### dirPath
6067
+
6068
+ > **dirPath**: `string`
6069
+
6070
+ 要创建的目录路径。
6071
+
6072
+ ##### recursive?
6073
+
6074
+ > `optional` **recursive**: `boolean`
6075
+
6076
+ 是否递归创建该目录的上级目录。
6077
+
6078
+ 设为 `true` 时,即使中间路径不存在也会一并创建(类似 `mkdir -p`)。
6079
+
6080
+ ###### Default
6081
+
6082
+ ```ts
6083
+ false
6084
+ ```
6085
+
6086
+ ***
6087
+
5116
6088
  ### NavigateBackParams
5117
6089
 
5118
6090
  #### Properties
@@ -5373,41 +6345,135 @@ Login result, true means success, false means failure
5373
6345
 
5374
6346
  ***
5375
6347
 
5376
- ### PrivacySettingResult
6348
+ ### PrivacySettingResult
6349
+
6350
+ #### Properties
6351
+
6352
+ ##### needAuthorization
6353
+
6354
+ > **needAuthorization**: `boolean`
6355
+
6356
+ Whether user authorization for privacy agreement is required
6357
+
6358
+ ***
6359
+
6360
+ ### ReadBLECharacteristicValueParams
6361
+
6362
+ 读取 BLE 特征值的请求参数。
6363
+
6364
+ #### Properties
6365
+
6366
+ ##### characteristicId
6367
+
6368
+ > **characteristicId**: `string`
6369
+
6370
+ 特征值 ID。
6371
+
6372
+ ##### deviceId
6373
+
6374
+ > **deviceId**: `string`
6375
+
6376
+ 蓝牙设备 ID。
6377
+
6378
+ ##### serviceId
6379
+
6380
+ > **serviceId**: `string`
6381
+
6382
+ 服务 ID。
6383
+
6384
+ ***
6385
+
6386
+ ### ReadFileParams
6387
+
6388
+ [FileSystemManager.readFile](doubao-apps-sdk-open-api.md#readfile) 的参数。
6389
+
6390
+ #### Properties
6391
+
6392
+ ##### encoding?
6393
+
6394
+ > `optional` **encoding**: `"base64"` \| `"utf-8"`
6395
+
6396
+ 指定读取文件的字符编码。
6397
+
6398
+ - `'utf-8'`:以 UTF-8 字符串形式返回文件内容。
6399
+ - `'base64'`:以 Base64 编码字符串形式返回文件内容,适用于二进制文件。
6400
+
6401
+ ###### Default
6402
+
6403
+ ```ts
6404
+ 'utf-8'
6405
+ ```
6406
+
6407
+ ##### filePath
6408
+
6409
+ > **filePath**: `string`
6410
+
6411
+ 要读取的文件路径(本地路径)。
6412
+
6413
+ ***
6414
+
6415
+ ### ReadFileResult
6416
+
6417
+ [FileSystemManager.readFile](doubao-apps-sdk-open-api.md#readfile) 的返回结果。
6418
+
6419
+ #### Properties
6420
+
6421
+ ##### data
6422
+
6423
+ > **data**: `string`
6424
+
6425
+ 文件内容。
6426
+
6427
+ 具体格式由 [ReadFileParams.encoding](doubao-apps-sdk-open-api.md#encoding-1) 决定:
6428
+ - 编码为 `'utf-8'` 时返回 UTF-8 字符串;
6429
+ - 编码为 `'base64'` 时返回 Base64 编码后的字符串。
6430
+
6431
+ ***
6432
+
6433
+ ### ReaddirParams
6434
+
6435
+ [FileSystemManager.readdir](doubao-apps-sdk-open-api.md#readdir) 的参数。
5377
6436
 
5378
6437
  #### Properties
5379
6438
 
5380
- ##### needAuthorization
6439
+ ##### dirPath
5381
6440
 
5382
- > **needAuthorization**: `boolean`
6441
+ > **dirPath**: `string`
5383
6442
 
5384
- Whether user authorization for privacy agreement is required
6443
+ 要读取的目录路径。
5385
6444
 
5386
6445
  ***
5387
6446
 
5388
- ### ReadBLECharacteristicValueParams
6447
+ ### ReaddirResult
5389
6448
 
5390
- 读取 BLE 特征值的请求参数。
6449
+ [FileSystemManager.readdir](doubao-apps-sdk-open-api.md#readdir) 的返回结果。
5391
6450
 
5392
6451
  #### Properties
5393
6452
 
5394
- ##### characteristicId
6453
+ ##### files
5395
6454
 
5396
- > **characteristicId**: `string`
6455
+ > **files**: `string`[]
5397
6456
 
5398
- 特征值 ID。
6457
+ 目录下的文件和子目录名称列表(不含 `.` 和 `..`)。
5399
6458
 
5400
- ##### deviceId
6459
+ ***
5401
6460
 
5402
- > **deviceId**: `string`
6461
+ ### RemoveSavedFileParams
5403
6462
 
5404
- 蓝牙设备 ID。
6463
+ [FileSystemManager.removeSavedFile](doubao-apps-sdk-open-api.md#removesavedfile) 的参数。
5405
6464
 
5406
- ##### serviceId
6465
+ #### Remarks
5407
6466
 
5408
- > **serviceId**: `string`
6467
+ - 该接口用于删除通过 [FileSystemManager.saveFile](doubao-apps-sdk-open-api.md#savefile) 保存的本地文件。
6468
+ - 对非已保存文件调用该接口可能会失败。
5409
6469
 
5410
- 服务 ID。
6470
+ #### Properties
6471
+
6472
+ ##### filePath
6473
+
6474
+ > **filePath**: `string`
6475
+
6476
+ 需要删除的已保存文件路径(应为 [SaveFileResult.savedFilePath](doubao-apps-sdk-open-api.md#savedfilepath) 返回的路径)。
5411
6477
 
5412
6478
  ***
5413
6479
 
@@ -5423,6 +6489,31 @@ Whether user authorization for privacy agreement is required
5423
6489
 
5424
6490
  ***
5425
6491
 
6492
+ ### RenameParams
6493
+
6494
+ [FileSystemManager.rename](doubao-apps-sdk-open-api.md#rename) 的参数。
6495
+
6496
+ #### Remarks
6497
+
6498
+ - 可用于重命名文件或将文件移动到同一文件系统中的其他路径。
6499
+ - 如果目标路径已存在同名文件,行为取决于宿主实现(通常会覆盖)。
6500
+
6501
+ #### Properties
6502
+
6503
+ ##### newPath
6504
+
6505
+ > **newPath**: `string`
6506
+
6507
+ 新文件路径(即重命名或移动后的目标路径)。
6508
+
6509
+ ##### oldPath
6510
+
6511
+ > **oldPath**: `string`
6512
+
6513
+ 源文件路径(即当前文件路径)。
6514
+
6515
+ ***
6516
+
5426
6517
  ### ReportEventParams
5427
6518
 
5428
6519
  上报数据分析事件的请求参数。
@@ -5622,6 +6713,76 @@ HTTP 状态码。
5622
6713
 
5623
6714
  ***
5624
6715
 
6716
+ ### RmdirParams
6717
+
6718
+ [FileSystemManager.rmdir](doubao-apps-sdk-open-api.md#rmdir) 的参数。
6719
+
6720
+ #### Properties
6721
+
6722
+ ##### dirPath
6723
+
6724
+ > **dirPath**: `string`
6725
+
6726
+ 要删除的目录路径。
6727
+
6728
+ ##### recursive?
6729
+
6730
+ > `optional` **recursive**: `boolean`
6731
+
6732
+ 是否递归删除目录下的所有子文件和子目录。
6733
+
6734
+ 设为 `false` 时,仅当目录为空才能删除成功;设为 `true` 时会递归删除所有内容。
6735
+
6736
+ ###### Default
6737
+
6738
+ ```ts
6739
+ false
6740
+ ```
6741
+
6742
+ ***
6743
+
6744
+ ### SaveFileParams
6745
+
6746
+ [FileSystemManager.saveFile](doubao-apps-sdk-open-api.md#savefile) 的参数。
6747
+
6748
+ #### Remarks
6749
+
6750
+ - 该接口用于将临时文件保存到本地持久化存储。临时文件在应用退出后可能被系统清理,
6751
+ 通过 `saveFile` 保存后的文件将不会被自动清理。
6752
+ - 保存成功后原临时文件会被移除。
6753
+
6754
+ #### Properties
6755
+
6756
+ ##### filePath?
6757
+
6758
+ > `optional` **filePath**: `string`
6759
+
6760
+ 保存到的目标文件路径。
6761
+
6762
+ 若不指定,则由宿主决定存储位置并通过 [SaveFileResult.savedFilePath](doubao-apps-sdk-open-api.md#savedfilepath) 返回。
6763
+
6764
+ ##### tempFilePath
6765
+
6766
+ > **tempFilePath**: `string`
6767
+
6768
+ 临时文件路径(需先通过下载或其他方式获得的临时文件路径)。
6769
+
6770
+ ***
6771
+
6772
+ ### SaveFileResult
6773
+
6774
+ [FileSystemManager.saveFile](doubao-apps-sdk-open-api.md#savefile) 的返回结果。
6775
+
6776
+ #### Properties
6777
+
6778
+ ##### savedFilePath
6779
+
6780
+ > **savedFilePath**: `string`
6781
+
6782
+ 文件保存后的实际存储路径。
6783
+
6784
+ ***
6785
+
5625
6786
  ### SaveImageToPhotosAlbumParams
5626
6787
 
5627
6788
  保存图片到系统相册的请求参数。
@@ -5862,7 +7023,7 @@ HTTP 状态码。
5862
7023
 
5863
7024
  ### SetWifiListParams
5864
7025
 
5865
- 设置 Wi-Fi 预设列表的请求参数。
7026
+ 设置 Wi-Fi 预设列表的请求参数(iOS 特有)。
5866
7027
 
5867
7028
  #### Properties
5868
7029
 
@@ -6496,6 +7657,113 @@ iOS 下是否忽略蓝牙可用性校验。
6496
7657
 
6497
7658
  ***
6498
7659
 
7660
+ ### StatParams
7661
+
7662
+ [FileSystemManager.stat](doubao-apps-sdk-open-api.md#stat) 的参数。
7663
+
7664
+ #### Properties
7665
+
7666
+ ##### path
7667
+
7668
+ > **path**: `string`
7669
+
7670
+ 要获取状态信息的文件或目录路径。
7671
+
7672
+ ***
7673
+
7674
+ ### StatResult
7675
+
7676
+ [FileSystemManager.stat](doubao-apps-sdk-open-api.md#stat) 的返回结果。
7677
+
7678
+ #### Properties
7679
+
7680
+ ##### isDirectory
7681
+
7682
+ > **isDirectory**: `boolean`
7683
+
7684
+ 判断当前路径是否是一个目录。
7685
+
7686
+ ##### lastModifiedTime
7687
+
7688
+ > **lastModifiedTime**: `number`
7689
+
7690
+ 文件最近一次被修改的时间戳,单位为毫秒。
7691
+
7692
+ ##### size
7693
+
7694
+ > **size**: `number`
7695
+
7696
+ 文件大小,单位为字节(Byte)。
7697
+
7698
+ ***
7699
+
7700
+ ### TruncateParams
7701
+
7702
+ [FileSystemManager.truncate](doubao-apps-sdk-open-api.md#truncate) 的参数。
7703
+
7704
+ #### Properties
7705
+
7706
+ ##### filePath
7707
+
7708
+ > **filePath**: `string`
7709
+
7710
+ 要截断的文件路径。
7711
+
7712
+ ##### length?
7713
+
7714
+ > `optional` **length**: `number`
7715
+
7716
+ 截断后的文件字节长度。
7717
+
7718
+ - 若 `length` 小于文件原始长度,文件将被截取到指定长度,多余部分丢弃。
7719
+ - 若 `length` 大于文件原始长度,文件将被扩展到指定长度,扩展部分用 `\0` 填充。
7720
+
7721
+ ###### Default
7722
+
7723
+ ```ts
7724
+ 0
7725
+ ```
7726
+
7727
+ ***
7728
+
7729
+ ### UnlinkParams
7730
+
7731
+ [FileSystemManager.unlink](doubao-apps-sdk-open-api.md#unlink) 的参数。
7732
+
7733
+ #### Properties
7734
+
7735
+ ##### filePath
7736
+
7737
+ > **filePath**: `string`
7738
+
7739
+ 要删除的文件路径。
7740
+
7741
+ 该接口只能删除文件,不能删除目录;删除目录应使用 [FileSystemManager.rmdir](doubao-apps-sdk-open-api.md#rmdir)。
7742
+
7743
+ ***
7744
+
7745
+ ### UnzipParams
7746
+
7747
+ [FileSystemManager.unzip](doubao-apps-sdk-open-api.md#unzip) 的参数。
7748
+
7749
+ #### Properties
7750
+
7751
+ ##### targetPath
7752
+
7753
+ > **targetPath**: `string`
7754
+
7755
+ 解压后的目标目录路径。
7756
+
7757
+ 目标目录须已存在,否则解压会失败。
7758
+
7759
+ ##### zipFilePath
7760
+
7761
+ > **zipFilePath**: `string`
7762
+
7763
+ 要解压的 zip 文件路径。
7764
+
7765
+ ***
7766
+
6499
7767
  ### UpdateModelContextParams
6500
7768
 
6501
7769
  #### Properties
@@ -6520,6 +7788,58 @@ iOS 下是否忽略蓝牙可用性校验。
6520
7788
 
6521
7789
  ***
6522
7790
 
7791
+ ### UpdateTaskParams
7792
+
7793
+ 更新任务的请求参数。
7794
+
7795
+ #### Properties
7796
+
7797
+ ##### taskDetail?
7798
+
7799
+ > `optional` **taskDetail**: `string`
7800
+
7801
+ 模板对应的数据的 JSON 字符串,与 taskStatus 二选一
7802
+
7803
+ ##### taskId
7804
+
7805
+ > **taskId**: `string`
7806
+
7807
+ 任务 ID
7808
+
7809
+ ##### taskStatus?
7810
+
7811
+ > `optional` **taskStatus**: [`TaskStatus`](doubao-apps-sdk-open-api.md#taskstatus-2)
7812
+
7813
+ 任务状态,与 taskDetail 二选一
7814
+
7815
+ ***
7816
+
7817
+ ### UpdateTaskResult
7818
+
7819
+ 更新任务的返回结果。
7820
+
7821
+ #### Properties
7822
+
7823
+ ##### expiresIn?
7824
+
7825
+ > `optional` **expiresIn**: `number`
7826
+
7827
+ 任务超时过期时间
7828
+
7829
+ ##### nextToken?
7830
+
7831
+ > `optional` **nextToken**: `string`
7832
+
7833
+ 每次更新后旧的 token 失效,必须使用新返回的 token
7834
+
7835
+ ##### taskId
7836
+
7837
+ > **taskId**: `string`
7838
+
7839
+ 任务 ID,更新后任务 ID 不变
7840
+
7841
+ ***
7842
+
6523
7843
  ### UpdateWidgetParams
6524
7844
 
6525
7845
  #### Properties
@@ -6564,6 +7884,20 @@ iOS 下是否忽略蓝牙可用性校验。
6564
7884
 
6565
7885
  ***
6566
7886
 
7887
+ ### WifiConnectedEvent
7888
+
7889
+ Wi-Fi 连接事件。
7890
+
7891
+ #### Properties
7892
+
7893
+ ##### wifi
7894
+
7895
+ > **wifi**: [`WifiInfo`](doubao-apps-sdk-open-api.md#wifiinfo)
7896
+
7897
+ 已连接的 Wi-Fi 信息。
7898
+
7899
+ ***
7900
+
6567
7901
  ### WifiInfo
6568
7902
 
6569
7903
  Wi-Fi 信息。
@@ -6706,6 +8040,46 @@ Wi-Fi SSID。
6706
8040
 
6707
8041
  写入模式。
6708
8042
 
8043
+ ***
8044
+
8045
+ ### WriteFileParams
8046
+
8047
+ [FileSystemManager.writeFile](doubao-apps-sdk-open-api.md#writefile) 的参数。
8048
+
8049
+ #### Remarks
8050
+
8051
+ - 如果文件不存在会自动创建;如果文件已存在则会覆盖原有内容。
8052
+ - 父目录不存在时写入会失败,需先通过 [FileSystemManager.mkdir](doubao-apps-sdk-open-api.md#mkdir) 创建目录。
8053
+
8054
+ #### Properties
8055
+
8056
+ ##### data
8057
+
8058
+ > **data**: `string`
8059
+
8060
+ 要写入的内容。
8061
+
8062
+ - 当 `encoding` 为 `'utf-8'` 时,直接写入该字符串;
8063
+ - 当 `encoding` 为 `'base64'` 时,将该字符串先进行 Base64 解码再写入文件。
8064
+
8065
+ ##### encoding?
8066
+
8067
+ > `optional` **encoding**: `"base64"` \| `"utf-8"`
8068
+
8069
+ 指定写入文件的字符编码。
8070
+
8071
+ ###### Default
8072
+
8073
+ ```ts
8074
+ 'utf-8'
8075
+ ```
8076
+
8077
+ ##### filePath
8078
+
8079
+ > **filePath**: `string`
8080
+
8081
+ 要写入的文件路径(本地路径)。
8082
+
6709
8083
  ## Type Aliases
6710
8084
 
6711
8085
  ### AccelerometerChangeListener()
@@ -7001,6 +8375,36 @@ Widget 登录类型。
7001
8375
 
7002
8376
  ***
7003
8377
 
8378
+ ### TaskStatus
8379
+
8380
+ > **TaskStatus**: `"running"` \| `"completed"`
8381
+
8382
+ 任务状态。
8383
+
8384
+ running 表示任务运行中,completed 表示任务已完成。
8385
+
8386
+ ***
8387
+
8388
+ ### TaskTemplate
8389
+
8390
+ > **TaskTemplate**: `"remote_normal_v1"`
8391
+
8392
+ 任务样式模板。
8393
+
8394
+ 当前仅支持 remote_normal_v1。
8395
+
8396
+ ***
8397
+
8398
+ ### TaskType
8399
+
8400
+ > **TaskType**: `"local"` \| `"remote"`
8401
+
8402
+ 任务类型。
8403
+
8404
+ local 表示本地任务,remote 表示远端任务。
8405
+
8406
+ ***
8407
+
7004
8408
  ### UserCaptureScreenListener()
7005
8409
 
7006
8410
  > **UserCaptureScreenListener**: (`event`) => `void`
@@ -7023,6 +8427,22 @@ Widget 登录类型。
7023
8427
 
7024
8428
  短震动类型。
7025
8429
 
8430
+ ***
8431
+
8432
+ ### WifiConnectedListener()
8433
+
8434
+ > **WifiConnectedListener**: (`event`) => `void`
8435
+
8436
+ Wi-Fi 连接事件监听函数。
8437
+
8438
+ #### Parameters
8439
+
8440
+ • **event**: [`WifiConnectedEvent`](doubao-apps-sdk-open-api.md#wificonnectedevent)
8441
+
8442
+ #### Returns
8443
+
8444
+ `void`
8445
+
7026
8446
  ## Variables
7027
8447
 
7028
8448
  ### LoginType