@doubao-apps/create 0.0.27 → 0.0.28
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/36.js +1 -1
- package/dist/cli.js +10 -10
- package/dist/template-empty/AGENTS.md +20 -20
- package/dist/template-empty/package.json +2 -2
- package/dist/template-empty/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +2943 -0
- package/dist/template-empty/references/reference/open-api/02-/350/267/257/347/224/261.md +63 -0
- package/dist/template-empty/{.ai/reference/open-api/05- → references/reference/open-api/03-}/347/225/214/351/235/242-/350/276/223/345/205/245.md +30 -0
- package/dist/template-empty/references/reference/open-api/04-/346/225/260/346/215/256/345/210/206/346/236/220.md +67 -0
- package/dist/{template-starter/.ai/reference/open-api/16-ui- → template-empty/references/reference/open-api/12-ui-}/350/276/223/345/205/245.md +0 -16
- package/dist/template-empty/references/reference/open-api/README.md +32 -0
- package/dist/template-empty/{.ai → references}/reference/open-api.md +420 -10
- package/dist/template-starter/AGENTS.md +20 -20
- package/dist/template-starter/README.md +48 -33
- package/dist/template-starter/package.json +2 -2
- package/dist/template-starter/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +2943 -0
- package/dist/template-starter/references/reference/open-api/02-/350/267/257/347/224/261.md +63 -0
- package/dist/template-starter/{.ai/reference/open-api/05- → references/reference/open-api/03-}/347/225/214/351/235/242-/350/276/223/345/205/245.md +30 -0
- package/dist/template-starter/references/reference/open-api/04-/346/225/260/346/215/256/345/210/206/346/236/220.md +67 -0
- package/dist/{template-empty/.ai/reference/open-api/16-ui- → template-starter/references/reference/open-api/12-ui-}/350/276/223/345/205/245.md +0 -16
- package/dist/template-starter/references/reference/open-api/README.md +32 -0
- package/dist/template-starter/{.ai → references}/reference/open-api.md +420 -10
- package/package.json +1 -1
- package/dist/template-empty/.ai/guides/system-prompt.md +0 -331
- package/dist/template-empty/.ai/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -699
- package/dist/template-empty/.ai/reference/open-api/02-/345/255/230/345/202/250.md +0 -409
- package/dist/template-empty/.ai/reference/open-api/03-/350/267/257/347/224/261.md +0 -165
- package/dist/template-empty/.ai/reference/open-api/04-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
- package/dist/template-empty/.ai/reference/open-api/06-/347/275/221/347/273/234.md +0 -148
- package/dist/template-empty/.ai/reference/open-api/07-/345/252/222/344/275/223.md +0 -346
- package/dist/template-empty/.ai/reference/open-api/08-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +0 -546
- package/dist/template-empty/.ai/reference/open-api/README.md +0 -36
- package/dist/template-starter/.ai/guides/system-prompt.md +0 -331
- package/dist/template-starter/.ai/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -699
- package/dist/template-starter/.ai/reference/open-api/02-/345/255/230/345/202/250.md +0 -409
- package/dist/template-starter/.ai/reference/open-api/03-/350/267/257/347/224/261.md +0 -165
- package/dist/template-starter/.ai/reference/open-api/04-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
- package/dist/template-starter/.ai/reference/open-api/06-/347/275/221/347/273/234.md +0 -148
- package/dist/template-starter/.ai/reference/open-api/07-/345/252/222/344/275/223.md +0 -346
- package/dist/template-starter/.ai/reference/open-api/08-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +0 -546
- package/dist/template-starter/.ai/reference/open-api/README.md +0 -36
- /package/dist/template-empty/{.ai → references}/examples/common-patterns.md +0 -0
- /package/dist/template-empty/{.ai → references}/examples/component-basics.md +0 -0
- /package/dist/template-empty/{.ai → references}/guides/best-practices.md +0 -0
- /package/dist/template-empty/{.ai → references}/guides/component-development.md +0 -0
- /package/dist/template-empty/{.ai → references}/guides/performance-optimization.md +0 -0
- /package/dist/template-empty/{.ai → references}/guides/troubleshooting.md +0 -0
- /package/dist/template-empty/{.ai → references}/reference/components-quick-ref.md +0 -0
- /package/dist/template-empty/{.ai → references}/reference/framework-api-quick-ref.md +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/09- → references/reference/open-api/05-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/10- → references/reference/open-api/06-}/350/256/276/345/244/207-wi-fi.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/11- → references/reference/open-api/07-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/12- → references/reference/open-api/08-}/350/256/276/345/244/207-ibeacon.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/13- → references/reference/open-api/09-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/14- → references/reference/open-api/10-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/15- → references/reference/open-api/11-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/17- → references/reference/open-api/13-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/18- → references/reference/open-api/14-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/19- → references/reference/open-api/15-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/20- → references/reference/open-api/16-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/21- → references/reference/open-api/17-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/22- → references/reference/open-api/18-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/23- → references/reference/open-api/19-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/24- → references/reference/open-api/20-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/25- → references/reference/open-api/21-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/26- → references/reference/open-api/22-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/27- → references/reference/open-api/23-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
- /package/dist/template-empty/{.ai/reference/open-api/28- → references/reference/open-api/24-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
- /package/dist/template-empty/{.ai → references}/rules/dos-and-donts.md +0 -0
- /package/dist/template-starter/{.ai → references}/examples/common-patterns.md +0 -0
- /package/dist/template-starter/{.ai → references}/examples/component-basics.md +0 -0
- /package/dist/template-starter/{.ai → references}/guides/best-practices.md +0 -0
- /package/dist/template-starter/{.ai → references}/guides/component-development.md +0 -0
- /package/dist/template-starter/{.ai → references}/guides/performance-optimization.md +0 -0
- /package/dist/template-starter/{.ai → references}/guides/troubleshooting.md +0 -0
- /package/dist/template-starter/{.ai → references}/reference/components-quick-ref.md +0 -0
- /package/dist/template-starter/{.ai → references}/reference/framework-api-quick-ref.md +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/09- → references/reference/open-api/05-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/10- → references/reference/open-api/06-}/350/256/276/345/244/207-wi-fi.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/11- → references/reference/open-api/07-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/12- → references/reference/open-api/08-}/350/256/276/345/244/207-ibeacon.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/13- → references/reference/open-api/09-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/14- → references/reference/open-api/10-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/15- → references/reference/open-api/11-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/17- → references/reference/open-api/13-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/18- → references/reference/open-api/14-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/19- → references/reference/open-api/15-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/20- → references/reference/open-api/16-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/21- → references/reference/open-api/17-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/22- → references/reference/open-api/18-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/23- → references/reference/open-api/19-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/24- → references/reference/open-api/20-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/25- → references/reference/open-api/21-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/26- → references/reference/open-api/22-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/27- → references/reference/open-api/23-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
- /package/dist/template-starter/{.ai/reference/open-api/28- → references/reference/open-api/24-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
- /package/dist/template-starter/{.ai → references}/rules/dos-and-donts.md +0 -0
|
@@ -328,6 +328,26 @@ closePage();
|
|
|
328
328
|
|
|
329
329
|
***
|
|
330
330
|
|
|
331
|
+
### createSignOrder()
|
|
332
|
+
|
|
333
|
+
> **createSignOrder**(`params`): `Promise`\<[`CreateSignOrderResult`](doubao-apps-sdk-open-api.md#createsignorderresult)\>
|
|
334
|
+
|
|
335
|
+
创建签约订单。
|
|
336
|
+
|
|
337
|
+
#### Parameters
|
|
338
|
+
|
|
339
|
+
• **params**: [`CreateSignOrderParams`](doubao-apps-sdk-open-api.md#createsignorderparams)
|
|
340
|
+
|
|
341
|
+
签约订单参数
|
|
342
|
+
|
|
343
|
+
#### Returns
|
|
344
|
+
|
|
345
|
+
`Promise`\<[`CreateSignOrderResult`](doubao-apps-sdk-open-api.md#createsignorderresult)\>
|
|
346
|
+
|
|
347
|
+
返回一个 Promise,解析为签约订单结果。
|
|
348
|
+
|
|
349
|
+
***
|
|
350
|
+
|
|
331
351
|
### disableAlertBeforeUnload()
|
|
332
352
|
|
|
333
353
|
> **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
|
|
@@ -348,16 +368,24 @@ closePage();
|
|
|
348
368
|
|
|
349
369
|
> **dispatchActionDirective**(`params`): `Promise`\<`object`\>
|
|
350
370
|
|
|
351
|
-
|
|
371
|
+
描述用户行为,约束模型行为并指定后续执行路径。
|
|
352
372
|
|
|
353
373
|
#### Parameters
|
|
354
374
|
|
|
355
375
|
• **params**: [`DispatchActionDirectiveParams`](doubao-apps-sdk-open-api.md#dispatchactiondirectiveparams)
|
|
356
376
|
|
|
377
|
+
动作描述、预期行为及工具调用约束参数。
|
|
378
|
+
|
|
357
379
|
#### Returns
|
|
358
380
|
|
|
359
381
|
`Promise`\<`object`\>
|
|
360
382
|
|
|
383
|
+
返回一个 Promise,在动作指令成功下发时解析。
|
|
384
|
+
|
|
385
|
+
#### Remarks
|
|
386
|
+
|
|
387
|
+
适用于卡片交互后向模型补充结构化动作上下文,例如按钮点击、选项选择或表单提交。
|
|
388
|
+
|
|
361
389
|
***
|
|
362
390
|
|
|
363
391
|
### enableAlertBeforeUnload()
|
|
@@ -870,19 +898,39 @@ console.log(result.networkType);
|
|
|
870
898
|
|
|
871
899
|
> **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
|
|
872
900
|
|
|
873
|
-
|
|
901
|
+
拉起收银台完成订单支付。
|
|
874
902
|
|
|
875
903
|
#### Parameters
|
|
876
904
|
|
|
877
905
|
• **params**: [`GetOrderPaymentParams`](doubao-apps-sdk-open-api.md#getorderpaymentparams)
|
|
878
906
|
|
|
879
|
-
|
|
907
|
+
支付参数
|
|
880
908
|
|
|
881
909
|
#### Returns
|
|
882
910
|
|
|
883
911
|
`Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
|
|
884
912
|
|
|
885
|
-
|
|
913
|
+
返回一个 Promise,成功时解析为订单支付结果。
|
|
914
|
+
|
|
915
|
+
***
|
|
916
|
+
|
|
917
|
+
### getOrderPaymentWithSign()
|
|
918
|
+
|
|
919
|
+
> **getOrderPaymentWithSign**(`params`): `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
|
|
920
|
+
|
|
921
|
+
使用签名信息拉起收银台完成订单支付。
|
|
922
|
+
|
|
923
|
+
#### Parameters
|
|
924
|
+
|
|
925
|
+
• **params**: [`GetOrderPaymentWithSignParams`](doubao-apps-sdk-open-api.md#getorderpaymentwithsignparams)
|
|
926
|
+
|
|
927
|
+
签名支付参数
|
|
928
|
+
|
|
929
|
+
#### Returns
|
|
930
|
+
|
|
931
|
+
`Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
|
|
932
|
+
|
|
933
|
+
返回一个 Promise,成功时解析为订单支付结果。
|
|
886
934
|
|
|
887
935
|
***
|
|
888
936
|
|
|
@@ -1195,16 +1243,24 @@ console.log(result.safeArea?.top, result.screenTop);
|
|
|
1195
1243
|
|
|
1196
1244
|
> **hideKeyboard**(`params`?): `Promise`\<`object`\>
|
|
1197
1245
|
|
|
1198
|
-
|
|
1246
|
+
收起当前键盘。
|
|
1199
1247
|
|
|
1200
1248
|
#### Parameters
|
|
1201
1249
|
|
|
1202
|
-
• **params
|
|
1250
|
+
• **params?**: [`HideKeyboardParam`](doubao-apps-sdk-open-api.md#hidekeyboardparam)
|
|
1203
1251
|
|
|
1204
1252
|
#### Returns
|
|
1205
1253
|
|
|
1206
1254
|
`Promise`\<`object`\>
|
|
1207
1255
|
|
|
1256
|
+
#### Example
|
|
1257
|
+
|
|
1258
|
+
```typescript
|
|
1259
|
+
import { hideKeyboard } from '@doubao-apps/framework/api';
|
|
1260
|
+
|
|
1261
|
+
await hideKeyboard({});
|
|
1262
|
+
```
|
|
1263
|
+
|
|
1208
1264
|
***
|
|
1209
1265
|
|
|
1210
1266
|
### hideLoading()
|
|
@@ -1797,6 +1853,40 @@ removeStorageSync({ key: 'profile' });
|
|
|
1797
1853
|
|
|
1798
1854
|
***
|
|
1799
1855
|
|
|
1856
|
+
### reportEvent()
|
|
1857
|
+
|
|
1858
|
+
> **reportEvent**(`params`): `Promise`\<`object`\>
|
|
1859
|
+
|
|
1860
|
+
上报数据分析事件。
|
|
1861
|
+
|
|
1862
|
+
#### Parameters
|
|
1863
|
+
|
|
1864
|
+
• **params**: [`ReportEventParams`](doubao-apps-sdk-open-api.md#reporteventparams)
|
|
1865
|
+
|
|
1866
|
+
数据分析事件上报参数。
|
|
1867
|
+
|
|
1868
|
+
#### Returns
|
|
1869
|
+
|
|
1870
|
+
`Promise`\<`object`\>
|
|
1871
|
+
|
|
1872
|
+
返回一个 Promise,在事件上报请求成功发起时解析。
|
|
1873
|
+
|
|
1874
|
+
#### Example
|
|
1875
|
+
|
|
1876
|
+
```typescript
|
|
1877
|
+
import { reportEvent } from '@doubao-apps/framework/api';
|
|
1878
|
+
|
|
1879
|
+
await reportEvent({
|
|
1880
|
+
eventName: 'page_view',
|
|
1881
|
+
data: {
|
|
1882
|
+
pageName: 'home',
|
|
1883
|
+
source: 'feed'
|
|
1884
|
+
}
|
|
1885
|
+
});
|
|
1886
|
+
```
|
|
1887
|
+
|
|
1888
|
+
***
|
|
1889
|
+
|
|
1800
1890
|
### request()
|
|
1801
1891
|
|
|
1802
1892
|
> **request**(`params`): `Promise`\<[`RequestResponse`](doubao-apps-sdk-open-api.md#requestresponse)\>
|
|
@@ -1837,6 +1927,26 @@ console.log(result.statusCode, result.data);
|
|
|
1837
1927
|
|
|
1838
1928
|
***
|
|
1839
1929
|
|
|
1930
|
+
### requestCombineOrder()
|
|
1931
|
+
|
|
1932
|
+
> **requestCombineOrder**(`params`): `Promise`\<[`RequestCombineOrderResult`](doubao-apps-sdk-open-api.md#requestcombineorderresult)\>
|
|
1933
|
+
|
|
1934
|
+
请求创建合单订单。
|
|
1935
|
+
|
|
1936
|
+
#### Parameters
|
|
1937
|
+
|
|
1938
|
+
• **params**: [`RequestCombineOrderParams`](doubao-apps-sdk-open-api.md#requestcombineorderparams)
|
|
1939
|
+
|
|
1940
|
+
合单订单参数
|
|
1941
|
+
|
|
1942
|
+
#### Returns
|
|
1943
|
+
|
|
1944
|
+
`Promise`\<[`RequestCombineOrderResult`](doubao-apps-sdk-open-api.md#requestcombineorderresult)\>
|
|
1945
|
+
|
|
1946
|
+
返回一个 Promise,解析为合单订单结果。
|
|
1947
|
+
|
|
1948
|
+
***
|
|
1949
|
+
|
|
1840
1950
|
### requestOrder()
|
|
1841
1951
|
|
|
1842
1952
|
> **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](doubao-apps-sdk-open-api.md#requestorderresult)\>
|
|
@@ -2285,6 +2395,26 @@ showToast({
|
|
|
2285
2395
|
|
|
2286
2396
|
***
|
|
2287
2397
|
|
|
2398
|
+
### sign()
|
|
2399
|
+
|
|
2400
|
+
> **sign**(`params`): `Promise`\<[`SignResult`](doubao-apps-sdk-open-api.md#signresult)\>
|
|
2401
|
+
|
|
2402
|
+
拉起签约流程。
|
|
2403
|
+
|
|
2404
|
+
#### Parameters
|
|
2405
|
+
|
|
2406
|
+
• **params**: [`SignParams`](doubao-apps-sdk-open-api.md#signparams)
|
|
2407
|
+
|
|
2408
|
+
签约参数
|
|
2409
|
+
|
|
2410
|
+
#### Returns
|
|
2411
|
+
|
|
2412
|
+
`Promise`\<[`SignResult`](doubao-apps-sdk-open-api.md#signresult)\>
|
|
2413
|
+
|
|
2414
|
+
返回一个 Promise,解析为签约结果。
|
|
2415
|
+
|
|
2416
|
+
***
|
|
2417
|
+
|
|
2288
2418
|
### startAccelerometer()
|
|
2289
2419
|
|
|
2290
2420
|
> **startAccelerometer**(`params`?): `Promise`\<`object`\>
|
|
@@ -2539,13 +2669,13 @@ Wi-Fi 流程入口。
|
|
|
2539
2669
|
|
|
2540
2670
|
### updateModelContext()
|
|
2541
2671
|
|
|
2542
|
-
> **updateModelContext**(`params
|
|
2672
|
+
> **updateModelContext**(`params`): `Promise`\<`object`\>
|
|
2543
2673
|
|
|
2544
2674
|
向 Agent 捐赠上下文
|
|
2545
2675
|
|
|
2546
2676
|
#### Parameters
|
|
2547
2677
|
|
|
2548
|
-
• **params
|
|
2678
|
+
• **params**: [`UpdateModelContextParams`](doubao-apps-sdk-open-api.md#updatemodelcontextparams)
|
|
2549
2679
|
|
|
2550
2680
|
#### Returns
|
|
2551
2681
|
|
|
@@ -2623,6 +2753,8 @@ value 需要是 ArrayBuffer。
|
|
|
2623
2753
|
|
|
2624
2754
|
### ActionDirectiveType
|
|
2625
2755
|
|
|
2756
|
+
用户动作指令类型。
|
|
2757
|
+
|
|
2626
2758
|
#### Enumeration Members
|
|
2627
2759
|
|
|
2628
2760
|
##### BUTTON\_CLICK
|
|
@@ -3649,8 +3781,70 @@ Wi-Fi SSID。
|
|
|
3649
3781
|
|
|
3650
3782
|
***
|
|
3651
3783
|
|
|
3784
|
+
### CreateSignOrderFailResult
|
|
3785
|
+
|
|
3786
|
+
#### Properties
|
|
3787
|
+
|
|
3788
|
+
##### errLogId?
|
|
3789
|
+
|
|
3790
|
+
> `optional` **errLogId**: `string`
|
|
3791
|
+
|
|
3792
|
+
用于问题排查的错误日志 ID。
|
|
3793
|
+
|
|
3794
|
+
##### errMsg
|
|
3795
|
+
|
|
3796
|
+
> **errMsg**: `string`
|
|
3797
|
+
|
|
3798
|
+
错误信息。
|
|
3799
|
+
|
|
3800
|
+
##### errNo
|
|
3801
|
+
|
|
3802
|
+
> **errNo**: `string`
|
|
3803
|
+
|
|
3804
|
+
错误码。
|
|
3805
|
+
|
|
3806
|
+
***
|
|
3807
|
+
|
|
3808
|
+
### CreateSignOrderParams
|
|
3809
|
+
|
|
3810
|
+
#### Properties
|
|
3811
|
+
|
|
3812
|
+
##### data
|
|
3813
|
+
|
|
3814
|
+
> **data**: `string`
|
|
3815
|
+
|
|
3816
|
+
签约订单请求数据。
|
|
3817
|
+
|
|
3818
|
+
##### dbAuthorization
|
|
3819
|
+
|
|
3820
|
+
> **dbAuthorization**: `string`
|
|
3821
|
+
|
|
3822
|
+
签约订单授权信息。
|
|
3823
|
+
|
|
3824
|
+
***
|
|
3825
|
+
|
|
3826
|
+
### CreateSignOrderSuccessResult
|
|
3827
|
+
|
|
3828
|
+
#### Properties
|
|
3829
|
+
|
|
3830
|
+
##### authOrderId
|
|
3831
|
+
|
|
3832
|
+
> **authOrderId**: `string`
|
|
3833
|
+
|
|
3834
|
+
签约订单 ID。
|
|
3835
|
+
|
|
3836
|
+
##### logId
|
|
3837
|
+
|
|
3838
|
+
> **logId**: `string`
|
|
3839
|
+
|
|
3840
|
+
用于问题排查的日志 ID。
|
|
3841
|
+
|
|
3842
|
+
***
|
|
3843
|
+
|
|
3652
3844
|
### DispatchActionDirectiveParams
|
|
3653
3845
|
|
|
3846
|
+
下发动作指令的请求参数。
|
|
3847
|
+
|
|
3654
3848
|
#### Properties
|
|
3655
3849
|
|
|
3656
3850
|
##### actionDescribe
|
|
@@ -3665,6 +3859,30 @@ Wi-Fi SSID。
|
|
|
3665
3859
|
|
|
3666
3860
|
动作类型,参见 [ActionDirectiveType](doubao-apps-sdk-open-api.md#actiondirectivetype)
|
|
3667
3861
|
|
|
3862
|
+
##### expectedAction
|
|
3863
|
+
|
|
3864
|
+
> **expectedAction**: `string`
|
|
3865
|
+
|
|
3866
|
+
自然语言描述,例如:调用话费账单查询工具,基于工具返回回复用户。如果有卡片需要引用卡片
|
|
3867
|
+
|
|
3868
|
+
##### responseHint?
|
|
3869
|
+
|
|
3870
|
+
> `optional` **responseHint**: `string`
|
|
3871
|
+
|
|
3872
|
+
自然语言描述,例如:严格参照提供的工具入参来调用工具,不要调用除bill_check以外的其他工具,只能严格基于bill_check工具返回结果进行回复
|
|
3873
|
+
|
|
3874
|
+
##### toolName?
|
|
3875
|
+
|
|
3876
|
+
> `optional` **toolName**: `string`
|
|
3877
|
+
|
|
3878
|
+
mcp名称,如果expectedAction里预期要调用工具,需要在这里写明调用工具的mcp name
|
|
3879
|
+
|
|
3880
|
+
##### toolParams?
|
|
3881
|
+
|
|
3882
|
+
> `optional` **toolParams**: `Record`\<`string`, `string`\>
|
|
3883
|
+
|
|
3884
|
+
mcp入参,如果expectedAction里预期要调用工具,需要在这里写明调用工具的入参
|
|
3885
|
+
|
|
3668
3886
|
##### widgetInstanceId
|
|
3669
3887
|
|
|
3670
3888
|
> **widgetInstanceId**: `string`
|
|
@@ -3721,12 +3939,24 @@ Wi-Fi SSID。
|
|
|
3721
3939
|
|
|
3722
3940
|
#### Properties
|
|
3723
3941
|
|
|
3942
|
+
##### detailText?
|
|
3943
|
+
|
|
3944
|
+
> `optional` **detailText**: `string`
|
|
3945
|
+
|
|
3946
|
+
点击失效卡要跳转的页面 detailText
|
|
3947
|
+
|
|
3724
3948
|
##### schema?
|
|
3725
3949
|
|
|
3726
3950
|
> `optional` **schema**: `string`
|
|
3727
3951
|
|
|
3728
3952
|
点击失效卡要跳转的页面 schema,格式与 navigateTo 的 url 相同
|
|
3729
3953
|
|
|
3954
|
+
##### title?
|
|
3955
|
+
|
|
3956
|
+
> `optional` **title**: `string`
|
|
3957
|
+
|
|
3958
|
+
点击失效卡要跳转的页面 title
|
|
3959
|
+
|
|
3730
3960
|
##### widgetInstanceId
|
|
3731
3961
|
|
|
3732
3962
|
> **widgetInstanceId**: `string`
|
|
@@ -4248,6 +4478,8 @@ RSSI 信号强度,单位 dBm。
|
|
|
4248
4478
|
|
|
4249
4479
|
> **orderId**: `string`
|
|
4250
4480
|
|
|
4481
|
+
订单 ID。
|
|
4482
|
+
|
|
4251
4483
|
***
|
|
4252
4484
|
|
|
4253
4485
|
### GetOrderPaymentResult
|
|
@@ -4258,10 +4490,38 @@ RSSI 信号强度,单位 dBm。
|
|
|
4258
4490
|
|
|
4259
4491
|
> **logId**: `string`
|
|
4260
4492
|
|
|
4493
|
+
用于问题排查的日志 ID。
|
|
4494
|
+
|
|
4261
4495
|
##### orderId
|
|
4262
4496
|
|
|
4263
4497
|
> **orderId**: `string`
|
|
4264
4498
|
|
|
4499
|
+
订单 ID。
|
|
4500
|
+
|
|
4501
|
+
***
|
|
4502
|
+
|
|
4503
|
+
### GetOrderPaymentWithSignParams
|
|
4504
|
+
|
|
4505
|
+
#### Properties
|
|
4506
|
+
|
|
4507
|
+
##### orderId
|
|
4508
|
+
|
|
4509
|
+
> **orderId**: `string`
|
|
4510
|
+
|
|
4511
|
+
订单 ID。
|
|
4512
|
+
|
|
4513
|
+
##### signData
|
|
4514
|
+
|
|
4515
|
+
> **signData**: `string`
|
|
4516
|
+
|
|
4517
|
+
支付签名数据。
|
|
4518
|
+
|
|
4519
|
+
##### signDbAuthorization
|
|
4520
|
+
|
|
4521
|
+
> **signDbAuthorization**: `string`
|
|
4522
|
+
|
|
4523
|
+
签名支付授权信息。
|
|
4524
|
+
|
|
4265
4525
|
***
|
|
4266
4526
|
|
|
4267
4527
|
### GetRandomValuesParams
|
|
@@ -4512,6 +4772,10 @@ Wi-Fi 的系统开关
|
|
|
4512
4772
|
|
|
4513
4773
|
***
|
|
4514
4774
|
|
|
4775
|
+
### HideKeyboardParam
|
|
4776
|
+
|
|
4777
|
+
***
|
|
4778
|
+
|
|
4515
4779
|
### IsBluetoothDevicePairedParams
|
|
4516
4780
|
|
|
4517
4781
|
查询蓝牙设备配对状态的请求参数。
|
|
@@ -4978,6 +5242,86 @@ Whether user authorization for privacy agreement is required
|
|
|
4978
5242
|
|
|
4979
5243
|
***
|
|
4980
5244
|
|
|
5245
|
+
### ReportEventParams
|
|
5246
|
+
|
|
5247
|
+
上报数据分析事件的请求参数。
|
|
5248
|
+
|
|
5249
|
+
#### Properties
|
|
5250
|
+
|
|
5251
|
+
##### data
|
|
5252
|
+
|
|
5253
|
+
> **data**: `Record`\<`string`, `any`\>
|
|
5254
|
+
|
|
5255
|
+
事件参数,会作为事件属性一并上报。
|
|
5256
|
+
|
|
5257
|
+
##### eventName
|
|
5258
|
+
|
|
5259
|
+
> **eventName**: `string`
|
|
5260
|
+
|
|
5261
|
+
事件名称。
|
|
5262
|
+
|
|
5263
|
+
***
|
|
5264
|
+
|
|
5265
|
+
### RequestCombineOrderFailResult
|
|
5266
|
+
|
|
5267
|
+
#### Properties
|
|
5268
|
+
|
|
5269
|
+
##### errLogId?
|
|
5270
|
+
|
|
5271
|
+
> `optional` **errLogId**: `string`
|
|
5272
|
+
|
|
5273
|
+
用于问题排查的错误日志 ID。
|
|
5274
|
+
|
|
5275
|
+
##### errMsg
|
|
5276
|
+
|
|
5277
|
+
> **errMsg**: `string`
|
|
5278
|
+
|
|
5279
|
+
错误信息。
|
|
5280
|
+
|
|
5281
|
+
##### errNo
|
|
5282
|
+
|
|
5283
|
+
> **errNo**: `string`
|
|
5284
|
+
|
|
5285
|
+
错误码。
|
|
5286
|
+
|
|
5287
|
+
***
|
|
5288
|
+
|
|
5289
|
+
### RequestCombineOrderParams
|
|
5290
|
+
|
|
5291
|
+
#### Properties
|
|
5292
|
+
|
|
5293
|
+
##### data
|
|
5294
|
+
|
|
5295
|
+
> **data**: `string`
|
|
5296
|
+
|
|
5297
|
+
合单订单请求数据。
|
|
5298
|
+
|
|
5299
|
+
##### dbAuthorization
|
|
5300
|
+
|
|
5301
|
+
> **dbAuthorization**: `string`
|
|
5302
|
+
|
|
5303
|
+
合单订单授权信息。
|
|
5304
|
+
|
|
5305
|
+
***
|
|
5306
|
+
|
|
5307
|
+
### RequestCombineOrderSuccessResult
|
|
5308
|
+
|
|
5309
|
+
#### Properties
|
|
5310
|
+
|
|
5311
|
+
##### combineOrderId
|
|
5312
|
+
|
|
5313
|
+
> **combineOrderId**: `string`
|
|
5314
|
+
|
|
5315
|
+
合单订单 ID。
|
|
5316
|
+
|
|
5317
|
+
##### logId
|
|
5318
|
+
|
|
5319
|
+
> **logId**: `string`
|
|
5320
|
+
|
|
5321
|
+
用于问题排查的日志 ID。
|
|
5322
|
+
|
|
5323
|
+
***
|
|
5324
|
+
|
|
4981
5325
|
### RequestOrderParams
|
|
4982
5326
|
|
|
4983
5327
|
#### Properties
|
|
@@ -5479,6 +5823,48 @@ HTTP 状态码。
|
|
|
5479
5823
|
|
|
5480
5824
|
***
|
|
5481
5825
|
|
|
5826
|
+
### SignFailResult
|
|
5827
|
+
|
|
5828
|
+
#### Properties
|
|
5829
|
+
|
|
5830
|
+
##### code
|
|
5831
|
+
|
|
5832
|
+
> **code**: `number`
|
|
5833
|
+
|
|
5834
|
+
错误码。
|
|
5835
|
+
|
|
5836
|
+
##### errLogId?
|
|
5837
|
+
|
|
5838
|
+
> `optional` **errLogId**: `string`
|
|
5839
|
+
|
|
5840
|
+
用于问题排查的错误日志 ID。
|
|
5841
|
+
|
|
5842
|
+
##### errMsg
|
|
5843
|
+
|
|
5844
|
+
> **errMsg**: `string`
|
|
5845
|
+
|
|
5846
|
+
错误信息。
|
|
5847
|
+
|
|
5848
|
+
##### errNo
|
|
5849
|
+
|
|
5850
|
+
> **errNo**: `string`
|
|
5851
|
+
|
|
5852
|
+
错误编号。
|
|
5853
|
+
|
|
5854
|
+
***
|
|
5855
|
+
|
|
5856
|
+
### SignParams
|
|
5857
|
+
|
|
5858
|
+
#### Properties
|
|
5859
|
+
|
|
5860
|
+
##### orderId
|
|
5861
|
+
|
|
5862
|
+
> **orderId**: `string`
|
|
5863
|
+
|
|
5864
|
+
签约订单 ID。
|
|
5865
|
+
|
|
5866
|
+
***
|
|
5867
|
+
|
|
5482
5868
|
### StartAccelerometerParams
|
|
5483
5869
|
|
|
5484
5870
|
开始监听加速度的请求参数。
|
|
@@ -5577,9 +5963,9 @@ iOS 下是否忽略蓝牙可用性校验。
|
|
|
5577
5963
|
|
|
5578
5964
|
#### Properties
|
|
5579
5965
|
|
|
5580
|
-
##### content
|
|
5966
|
+
##### content
|
|
5581
5967
|
|
|
5582
|
-
>
|
|
5968
|
+
> **content**: `string`
|
|
5583
5969
|
|
|
5584
5970
|
上下文内容,格式无约束,可以与 MCP 服务下发的上下文格式保持一致
|
|
5585
5971
|
|
|
@@ -5913,6 +6299,12 @@ iBeacon 距离等级。
|
|
|
5913
6299
|
|
|
5914
6300
|
***
|
|
5915
6301
|
|
|
6302
|
+
### CreateSignOrderResult
|
|
6303
|
+
|
|
6304
|
+
> **CreateSignOrderResult**: [`CreateSignOrderSuccessResult`](doubao-apps-sdk-open-api.md#createsignordersuccessresult) \| [`CreateSignOrderFailResult`](doubao-apps-sdk-open-api.md#createsignorderfailresult)
|
|
6305
|
+
|
|
6306
|
+
***
|
|
6307
|
+
|
|
5916
6308
|
### DeviceOrientation
|
|
5917
6309
|
|
|
5918
6310
|
> **DeviceOrientation**: `"portrait"` \| `"landscape"`
|
|
@@ -5994,6 +6386,12 @@ Widget 登录类型。
|
|
|
5994
6386
|
|
|
5995
6387
|
***
|
|
5996
6388
|
|
|
6389
|
+
### RequestCombineOrderResult
|
|
6390
|
+
|
|
6391
|
+
> **RequestCombineOrderResult**: [`RequestCombineOrderSuccessResult`](doubao-apps-sdk-open-api.md#requestcombineordersuccessresult) \| [`RequestCombineOrderFailResult`](doubao-apps-sdk-open-api.md#requestcombineorderfailresult)
|
|
6392
|
+
|
|
6393
|
+
***
|
|
6394
|
+
|
|
5997
6395
|
### RequestMethod
|
|
5998
6396
|
|
|
5999
6397
|
> **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
|
|
@@ -6038,6 +6436,18 @@ Widget 登录类型。
|
|
|
6038
6436
|
|
|
6039
6437
|
***
|
|
6040
6438
|
|
|
6439
|
+
### SignResult
|
|
6440
|
+
|
|
6441
|
+
> **SignResult**: [`SignSuccessResult`](doubao-apps-sdk-open-api.md#signsuccessresult) \| [`SignFailResult`](doubao-apps-sdk-open-api.md#signfailresult)
|
|
6442
|
+
|
|
6443
|
+
***
|
|
6444
|
+
|
|
6445
|
+
### SignSuccessResult
|
|
6446
|
+
|
|
6447
|
+
> **SignSuccessResult**: `Record`\<`string`, `never`\>
|
|
6448
|
+
|
|
6449
|
+
***
|
|
6450
|
+
|
|
6041
6451
|
### UserCaptureScreenListener()
|
|
6042
6452
|
|
|
6043
6453
|
> **UserCaptureScreenListener**: (`event`) => `void`
|
|
@@ -81,7 +81,7 @@ my-doubao-app/
|
|
|
81
81
|
|
|
82
82
|
页面/卡片目录下的入口文件必须命名为 **`index.tsx`**,样式文件为 **`index.scss`**。
|
|
83
83
|
|
|
84
|
-
**详细规则** → [
|
|
84
|
+
**详细规则** → [references/rules/dos-and-donts.md](references/rules/dos-and-donts.md)
|
|
85
85
|
|
|
86
86
|
---
|
|
87
87
|
|
|
@@ -126,7 +126,7 @@ export default definePage({
|
|
|
126
126
|
});
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
**开发指南** → [
|
|
129
|
+
**开发指南** → [references/guides/component-development.md](references/guides/component-development.md)
|
|
130
130
|
|
|
131
131
|
### Widget(卡片)
|
|
132
132
|
|
|
@@ -169,9 +169,9 @@ export default defineWidget({
|
|
|
169
169
|
});
|
|
170
170
|
```
|
|
171
171
|
|
|
172
|
-
**开发指南** → [
|
|
172
|
+
**开发指南** → [references/guides/component-development.md](references/guides/component-development.md)
|
|
173
173
|
|
|
174
|
-
**基础示例对比** → [
|
|
174
|
+
**基础示例对比** → [references/examples/component-basics.md](references/examples/component-basics.md)
|
|
175
175
|
|
|
176
176
|
---
|
|
177
177
|
|
|
@@ -183,10 +183,10 @@ export default defineWidget({
|
|
|
183
183
|
|
|
184
184
|
| 任务类型 | 文档 | 适用场景 |
|
|
185
185
|
|---------|-----------|---------|
|
|
186
|
-
| 组件开发 | [component-development.md](
|
|
187
|
-
| 最佳实践 | [best-practices.md](
|
|
188
|
-
| 性能优化 | [performance-optimization.md](
|
|
189
|
-
| 问题排查 | [troubleshooting.md](
|
|
186
|
+
| 组件开发 | [component-development.md](references/guides/component-development.md) | Page 和 Widget 完整开发指南 |
|
|
187
|
+
| 最佳实践 | [best-practices.md](references/guides/best-practices.md) | 代码规范、架构设计 |
|
|
188
|
+
| 性能优化 | [performance-optimization.md](references/guides/performance-optimization.md) | 渲染优化、内存管理 |
|
|
189
|
+
| 问题排查 | [troubleshooting.md](references/guides/troubleshooting.md) | 调试技巧、常见问题 |
|
|
190
190
|
|
|
191
191
|
---
|
|
192
192
|
|
|
@@ -194,9 +194,9 @@ export default defineWidget({
|
|
|
194
194
|
|
|
195
195
|
完整的 Framework API(框架核心)和 Bridge API(系统能力)列表:
|
|
196
196
|
|
|
197
|
-
- **[Framework API 快速参考](
|
|
198
|
-
- **[Open API 目录](
|
|
199
|
-
- **[组件库快速参考](
|
|
197
|
+
- **[Framework API 快速参考](references/reference/framework-api-quick-ref.md)** - 核心 Framework API 速查
|
|
198
|
+
- **[Open API 目录](references/reference/open-api/README.md)** - 公开可用的端能力(系统能力)目录与详细文档
|
|
199
|
+
- **[组件库快速参考](references/reference/components-quick-ref.md)** - SDK 内置组件(Button、Switch、Swiper 等)
|
|
200
200
|
|
|
201
201
|
包含:
|
|
202
202
|
- **Framework API**:组件定义(definePage、defineWidget)、生命周期、状态管理
|
|
@@ -217,8 +217,8 @@ Lynx 组件库完整参考文档请访问官方文档:
|
|
|
217
217
|
|
|
218
218
|
| 场景 | 示例文档 | 说明 |
|
|
219
219
|
|-----|---------|------|
|
|
220
|
-
| 组件基础 | [component-basics.md](
|
|
221
|
-
| 常用模式 | [common-patterns.md](
|
|
220
|
+
| 组件基础 | [component-basics.md](references/examples/component-basics.md) | Page 和 Widget 基础示例对比 |
|
|
221
|
+
| 常用模式 | [common-patterns.md](references/examples/common-patterns.md) | API 集成、状态管理、页面导航 |
|
|
222
222
|
|
|
223
223
|
---
|
|
224
224
|
|
|
@@ -228,9 +228,9 @@ Lynx 组件库完整参考文档请访问官方文档:
|
|
|
228
228
|
|
|
229
229
|
API 参考文档
|
|
230
230
|
|
|
231
|
-
- **[Framework API](
|
|
232
|
-
- **[组件库](
|
|
233
|
-
- **[Open API](
|
|
231
|
+
- **[Framework API](references/reference/framework-api-quick-ref.md)** - 核心 Framework API 速查
|
|
232
|
+
- **[组件库](references/reference/components-quick-ref.md)** - SDK 内置组件速查
|
|
233
|
+
- **[Open API](references/reference/open-api/README.md)** - 系统能力 API 目录与详细文档
|
|
234
234
|
|
|
235
235
|
### 依赖包
|
|
236
236
|
|
|
@@ -246,19 +246,19 @@ API 参考文档
|
|
|
246
246
|
|
|
247
247
|
遇到问题?先查看故障排查指南:
|
|
248
248
|
|
|
249
|
-
👉 **[故障排查指南](
|
|
249
|
+
👉 **[故障排查指南](references/guides/troubleshooting.md)**
|
|
250
250
|
|
|
251
251
|
### 最佳实践
|
|
252
252
|
|
|
253
253
|
想要提升代码质量?查看最佳实践:
|
|
254
254
|
|
|
255
|
-
👉 **[最佳实践指南](
|
|
255
|
+
👉 **[最佳实践指南](references/guides/best-practices.md)**
|
|
256
256
|
|
|
257
257
|
### 性能优化
|
|
258
258
|
|
|
259
259
|
应用性能不佳?查看性能优化指南:
|
|
260
260
|
|
|
261
|
-
👉 **[性能优化指南](
|
|
261
|
+
👉 **[性能优化指南](references/guides/performance-optimization.md)**
|
|
262
262
|
|
|
263
263
|
---
|
|
264
264
|
|
|
@@ -267,7 +267,7 @@ API 参考文档
|
|
|
267
267
|
```
|
|
268
268
|
项目根目录/
|
|
269
269
|
├── AGENTS.md # 主入口文档(AI Agent 必读)
|
|
270
|
-
└──
|
|
270
|
+
└── references/ # 详细文档目录
|
|
271
271
|
├── guides/ # 开发指南
|
|
272
272
|
├── rules/ # 开发规则
|
|
273
273
|
├── examples/ # 代码示例
|