clickgo 7.3.0 → 7.3.2
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/app/demo.cga +0 -0
- package/dist/app/task.cga +0 -0
- package/dist/control/common.cgc +0 -0
- package/dist/index.js +1 -1
- package/dist/lib/command/file.d.ts +87 -0
- package/dist/lib/command/runtime.d.ts +37 -0
- package/dist/lib/command/types.d.ts +161 -0
- package/dist/lib/command.d.ts +18 -151
- package/doc/clickgo-rag.md +463 -154
- package/package.json +2 -2
package/doc/clickgo-rag.md
CHANGED
|
@@ -219,6 +219,34 @@ export default class extends clickgo.form.AbstractForm {
|
|
|
219
219
|
|
|
220
220
|
`execute(this, name, args, { 'signal': signal })` 支持取消;执行回调通过第二个参数 `context.signal` 配合停止。取消不回滚已发生的修改,忽略 signal 的业务仍可继续,执行占用在回调实际结束后释放。context 包含 taskId、formId、panelId 和 source;source 的 user/agent 仅用于记录,不能作为授权凭据。
|
|
221
221
|
|
|
222
|
+
## 原生导出文件
|
|
223
|
+
|
|
224
|
+
应用将内置导出器生成的 Blob 交给 `context.createFile(blob, { fileName, mimeType? })`,再用 `success(data, [file])` 明确交付。框架不重新绘制文件,也不读取本机路径。示例使用文本,实际应用传入自己的 JPG、PDF 等成品 Blob:
|
|
225
|
+
|
|
226
|
+
```ts
|
|
227
|
+
clickgo.command.register(this, {
|
|
228
|
+
'name': 'document.export', 'description': 'Export the current document as text.',
|
|
229
|
+
'inputSchema': { 'type': 'object', 'additionalProperties': false },
|
|
230
|
+
'exposed': true,
|
|
231
|
+
'execute': (_args, context) => {
|
|
232
|
+
const blob = new Blob(['Example text\n'], { 'type': 'text/plain' });
|
|
233
|
+
const file = context.createFile(blob, { 'fileName': 'example.txt' });
|
|
234
|
+
return file === false ? clickgo.command.failure('export-failed', 'Could not retain the file')
|
|
235
|
+
: clickgo.command.success({ 'format': 'txt' }, [file]);
|
|
236
|
+
},
|
|
237
|
+
});
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
- 成功结果的 `files` 位于 `data` 外,不参与 `outputSchema` 校验。元数据包含文件名、MIME、原始字节数、有效期、URI、`readCommand` 和 `readChunkSize`;框架使用自己的快照,拒绝伪造、重复或跨 App 句柄。
|
|
241
|
+
- 文件保留 10 分钟,随所属 Panel、Form 或 App 销毁/`clear()` 释放。只允许执行中的 context 创建文件;失败、取消、无效输出或未放入结果的文件自动释放。私有命令的文件不会向代理公开。
|
|
242
|
+
- 每个 App 最多保留 8 份、合计 128 MiB,单文件最多 64 MiB;参数、容量或计时器不可用时 `createFile()` 返回 false,不自动淘汰尚未取走的文件。
|
|
243
|
+
- 应用可用 `releaseFile(this, fileId)` 主动释放旧缓存;Form/Panel 只能管理自身范围,App 可管理整个 App。释放不删除磁盘文件,客户端之后无法再读取该句柄。Demo 在新文件准备好后释放同 Form 的上一次导出,避免连续导出占满缓存。
|
|
244
|
+
- App 首次通过公开命令交付文件后,框架为该 App 自动注册保留命令名 `clickgo.file.read`;它不是 `clickgo.file` 库,也不会为每个 App 启动 MCP 服务。应用不能注册同名命令。JS 和 WebMCP 按元数据调用它,传 `fileId`、`offset`(默认 0)、`length`(默认 49152,最多 393216)读取;每段返回 `file`、`offset`、`nextOffset`、`encoding: base64`、`data`。逐段解码再拼接字节,直到 nextOffset 为 null,避免将二进制输出到对话。
|
|
245
|
+
- 文件按 `taskId + fileId` 隔离;`fileId` 使用 UUID,但不承担跨 App 授权。应用内 `command.execute(this, 'clickgo.file.read', args)` 从 this 取得 taskId;网页公开入口和外部 MCP 调用须提供目标 taskId。
|
|
246
|
+
- Native 的 HTTP/stdio MCP 将同一结果转换为标准 `resource_link`;客户端使用 `resources/read` 获取原文件。URI 为 `clickgo-file:///task/{taskId}/{fileId}`,不是可公网访问的下载地址;不支持资源读取的客户端仍可调用公开的分段命令。缺少浏览器下载事件不代表生成失败。
|
|
247
|
+
|
|
248
|
+
Demo 的 Library command → Export text file 演示完整流程。
|
|
249
|
+
|
|
222
250
|
## 浏览器代理与 WebMCP
|
|
223
251
|
|
|
224
252
|
框架自动发布 `window['clickgo']['command']`,不需要业务另建桥接文件,也不依赖 WebMCP。代理按以下顺序调用:
|
|
@@ -252,7 +280,11 @@ WebMCP 可用时框架自动发布公开命令,无需连接按钮。通过 `aw
|
|
|
252
280
|
| `publishedTaskIds` | 已完成工具发布的 App ID |
|
|
253
281
|
| `onWebMcpStatusChanged(status)` | Boot、App、Form 接收同一页面级状态,无 taskId、无需 root |
|
|
254
282
|
|
|
255
|
-
界面先读一次快照,再通过事件更新,无需轮询。事件不回放历史,App
|
|
283
|
+
界面先读一次快照,再通过事件更新,无需轮询。事件不回放历史,App 命令变化或发布失败不触发该事件。
|
|
284
|
+
|
|
285
|
+
公开命令注册或移除时框架自动同步,通常无需调用 `connectWebMcp(this)`。仅在发布失败需重试、主动撤销后需恢复,或浏览器稍后才提供 WebMCP 接口时调用;同一浏览器接口下保留已发布工具,只补齐缺失项,不重置 App 的命令或业务状态。发布失败返回 false。
|
|
286
|
+
|
|
287
|
+
`disconnectWebMcp(this)` 撤销当前 App 工具,不改变页面状态,之后注册公开命令仍会自动发布。WebMCP 不支持或发布失败时,网页 JS 入口仍可使用。
|
|
256
288
|
|
|
257
289
|
## 自动生成 AI 接入说明
|
|
258
290
|
|
|
@@ -7523,10 +7555,31 @@ Enter/Space 请求切换一次展开状态;忽略持续按住时的重复事
|
|
|
7523
7555
|
|
|
7524
7556
|
语义颜色,默认 `default`。
|
|
7525
7557
|
|
|
7558
|
+
#### clickable
|
|
7559
|
+
|
|
7560
|
+
`boolean` | `string`
|
|
7561
|
+
|
|
7562
|
+
整项可点击,默认 `false`;通过 `@click` 响应激活。启用后支持 Tab 聚焦、Enter 和 Space 激活;平时保持扁平,悬停、按下及键盘聚焦时显示反馈。不嵌套其他交互控件。
|
|
7563
|
+
|
|
7564
|
+
#### disabled
|
|
7565
|
+
|
|
7566
|
+
`boolean` | `string`
|
|
7567
|
+
|
|
7568
|
+
禁用可点击项,默认 `false`;禁用时不参与 Tab 导航、不触发 `click`。
|
|
7569
|
+
|
|
7570
|
+
### 事件
|
|
7571
|
+
|
|
7572
|
+
#### tap
|
|
7573
|
+
|
|
7574
|
+
`(event: MouseEvent | KeyboardEvent): void`
|
|
7575
|
+
|
|
7576
|
+
可点击项通过鼠标点击、Enter 按下或 Space 释放时触发,参数为原始事件。应用模板使用 `@click` 绑定,框架内部对应 `tap`;普通项或禁用项不触发。
|
|
7577
|
+
|
|
7526
7578
|
### 示例
|
|
7527
7579
|
|
|
7528
7580
|
```xml
|
|
7529
7581
|
<statusbar-item type="info">Synchronizing</statusbar-item>
|
|
7582
|
+
<statusbar-item clickable @click="chooseEncoding" tip="Change text encoding">UTF-8</statusbar-item>
|
|
7530
7583
|
```
|
|
7531
7584
|
|
|
7532
7585
|
|
|
@@ -10965,7 +11018,7 @@ lib/command/functions/clear.md
|
|
|
10965
11018
|
|
|
10966
11019
|
> **clear**(`current`): `void`
|
|
10967
11020
|
|
|
10968
|
-
Defined in: [lib/command.ts:
|
|
11021
|
+
Defined in: [lib/command.ts:89](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L89)
|
|
10969
11022
|
|
|
10970
11023
|
清理所属 Panel、Form 或整个任务的命令
|
|
10971
11024
|
|
|
@@ -10996,7 +11049,7 @@ lib/command/functions/clearOwner.md
|
|
|
10996
11049
|
|
|
10997
11050
|
> **clearOwner**(`taskId`, `formId?`, `panelId?`): `void`
|
|
10998
11051
|
|
|
10999
|
-
Defined in: [lib/command.ts:
|
|
11052
|
+
Defined in: [lib/command.ts:101](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L101)
|
|
11000
11053
|
|
|
11001
11054
|
**`Internal`**
|
|
11002
11055
|
|
|
@@ -11041,9 +11094,12 @@ lib/command/functions/connectWebMcp.md
|
|
|
11041
11094
|
|
|
11042
11095
|
> **connectWebMcp**(`current`): `Promise`\<`boolean`\>
|
|
11043
11096
|
|
|
11044
|
-
Defined in: [lib/command.ts:
|
|
11097
|
+
Defined in: [lib/command.ts:195](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L195)
|
|
11045
11098
|
|
|
11046
|
-
|
|
11099
|
+
手动将当前 App 已公开的命令发布到浏览器 WebMCP
|
|
11100
|
+
公开命令注册或移除时框架自动同步,通常无需调用。
|
|
11101
|
+
仅在发布失败需重试、主动撤销后需恢复,或浏览器稍后才提供 WebMCP 接口时调用。
|
|
11102
|
+
同一浏览器接口下保留已发布工具,只补齐缺失项;不重置 App 的命令或业务状态。
|
|
11047
11103
|
|
|
11048
11104
|
## Parameters
|
|
11049
11105
|
|
|
@@ -11057,7 +11113,7 @@ Defined in: [lib/command.ts:618](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11057
11113
|
|
|
11058
11114
|
`Promise`\<`boolean`\>
|
|
11059
11115
|
|
|
11060
|
-
|
|
11116
|
+
是否发布成功;浏览器不支持、App 已退出、发布中途撤销或注册失败时返回 false
|
|
11061
11117
|
|
|
11062
11118
|
lib/command/functions/createBridge.md
|
|
11063
11119
|
---
|
|
@@ -11072,7 +11128,7 @@ lib/command/functions/createBridge.md
|
|
|
11072
11128
|
|
|
11073
11129
|
> **createBridge**(`current`): [`IBridge`](../interfaces/IBridge.md)
|
|
11074
11130
|
|
|
11075
|
-
Defined in: [lib/command.ts:
|
|
11131
|
+
Defined in: [lib/command.ts:175](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L175)
|
|
11076
11132
|
|
|
11077
11133
|
创建绑定单个 App 的可复用代理接口,调用方无需反复传入 taskId
|
|
11078
11134
|
|
|
@@ -11103,7 +11159,7 @@ lib/command/functions/createPageBridge.md
|
|
|
11103
11159
|
|
|
11104
11160
|
> **createPageBridge**(): [`IPageBridge`](../interfaces/IPageBridge.md)
|
|
11105
11161
|
|
|
11106
|
-
Defined in: [lib/command.ts:
|
|
11162
|
+
Defined in: [lib/command.ts:183](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L183)
|
|
11107
11163
|
|
|
11108
11164
|
网页入口直接读取框架的任务及命令状态,无需应用或宿主重复发布与清理
|
|
11109
11165
|
|
|
@@ -11126,7 +11182,7 @@ lib/command/functions/disconnectWebMcp.md
|
|
|
11126
11182
|
|
|
11127
11183
|
> **disconnectWebMcp**(`current`): `void`
|
|
11128
11184
|
|
|
11129
|
-
Defined in: [lib/command.ts:
|
|
11185
|
+
Defined in: [lib/command.ts:204](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L204)
|
|
11130
11186
|
|
|
11131
11187
|
撤销当前 App 的 WebMCP 工具;不改变页面级接入状态,下次公开命令注册时自动发布
|
|
11132
11188
|
|
|
@@ -11155,9 +11211,9 @@ lib/command/functions/executeAgent.md
|
|
|
11155
11211
|
|
|
11156
11212
|
# Function: executeAgent()
|
|
11157
11213
|
|
|
11158
|
-
> **executeAgent**(`taskId`, `name`, `args?`, `options?`): `Promise`\<[`TResult`](../type-aliases/TResult.md)
|
|
11214
|
+
> **executeAgent**(`taskId`, `name`, `args?`, `options?`): `Promise`\<[`TResult`](../type-aliases/TResult.md)\>
|
|
11159
11215
|
|
|
11160
|
-
Defined in: [lib/command.ts:
|
|
11216
|
+
Defined in: [lib/command.ts:165](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L165)
|
|
11161
11217
|
|
|
11162
11218
|
代理直接按 taskId 执行公开命令,与界面共用校验和业务执行器
|
|
11163
11219
|
|
|
@@ -11191,7 +11247,7 @@ Defined in: [lib/command.ts:547](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11191
11247
|
|
|
11192
11248
|
## Returns
|
|
11193
11249
|
|
|
11194
|
-
`Promise`\<[`TResult`](../type-aliases/TResult.md)
|
|
11250
|
+
`Promise`\<[`TResult`](../type-aliases/TResult.md)\>
|
|
11195
11251
|
|
|
11196
11252
|
结构化结果;未公开或不存在的命令返回 not-found
|
|
11197
11253
|
|
|
@@ -11206,9 +11262,9 @@ lib/command/functions/execute.md
|
|
|
11206
11262
|
|
|
11207
11263
|
# Function: execute()
|
|
11208
11264
|
|
|
11209
|
-
> **execute**(`current`, `name`, `args?`, `options?`): `Promise`\<[`TResult`](../type-aliases/TResult.md)
|
|
11265
|
+
> **execute**(`current`, `name`, `args?`, `options?`): `Promise`\<[`TResult`](../type-aliases/TResult.md)\>
|
|
11210
11266
|
|
|
11211
|
-
Defined in: [lib/command.ts:
|
|
11267
|
+
Defined in: [lib/command.ts:152](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L152)
|
|
11212
11268
|
|
|
11213
11269
|
应用界面直接执行已注册的业务命令
|
|
11214
11270
|
|
|
@@ -11242,7 +11298,7 @@ Defined in: [lib/command.ts:534](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11242
11298
|
|
|
11243
11299
|
## Returns
|
|
11244
11300
|
|
|
11245
|
-
`Promise`\<[`TResult`](../type-aliases/TResult.md)
|
|
11301
|
+
`Promise`\<[`TResult`](../type-aliases/TResult.md)\>
|
|
11246
11302
|
|
|
11247
11303
|
业务结果
|
|
11248
11304
|
|
|
@@ -11259,7 +11315,7 @@ lib/command/functions/failure.md
|
|
|
11259
11315
|
|
|
11260
11316
|
> **failure**(`code`, `message`): [`TResult`](../type-aliases/TResult.md)\<`never`\>
|
|
11261
11317
|
|
|
11262
|
-
Defined in: [lib/command.ts:
|
|
11318
|
+
Defined in: [lib/command.ts:48](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L48)
|
|
11263
11319
|
|
|
11264
11320
|
构造业务失败结果,不抛异常
|
|
11265
11321
|
|
|
@@ -11296,7 +11352,7 @@ lib/command/functions/getAgentGuide.md
|
|
|
11296
11352
|
|
|
11297
11353
|
> **getAgentGuide**(`current?`, `options?`): `Promise`\<`string` \| `false` \| `null`\>
|
|
11298
11354
|
|
|
11299
|
-
Defined in: [lib/command.ts:
|
|
11355
|
+
Defined in: [lib/command.ts:139](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L139)
|
|
11300
11356
|
|
|
11301
11357
|
生成简短英文接入说明,不嵌入临时 App ID;代理通过接口实时发现
|
|
11302
11358
|
|
|
@@ -11333,7 +11389,7 @@ lib/command/functions/getAgentInfo.md
|
|
|
11333
11389
|
|
|
11334
11390
|
> **getAgentInfo**(`current?`, `options?`): `Promise`\<`false` \| [`IAgentInfo`](../interfaces/IAgentInfo.md) \| `null`\>
|
|
11335
11391
|
|
|
11336
|
-
Defined in: [lib/command.ts:
|
|
11392
|
+
Defined in: [lib/command.ts:128](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L128)
|
|
11337
11393
|
|
|
11338
11394
|
获取当前环境的统一接入信息,不另行维护命令清单或启用服务
|
|
11339
11395
|
|
|
@@ -11370,7 +11426,7 @@ lib/command/functions/init.md
|
|
|
11370
11426
|
|
|
11371
11427
|
> **init**(): `void`
|
|
11372
11428
|
|
|
11373
|
-
Defined in: [lib/command.ts:
|
|
11429
|
+
Defined in: [lib/command.ts:28](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L28)
|
|
11374
11430
|
|
|
11375
11431
|
初始化页面级 WebMCP 接入状态,由框架在执行 Boot.main 前自动调用
|
|
11376
11432
|
|
|
@@ -11393,7 +11449,7 @@ lib/command/functions/list.md
|
|
|
11393
11449
|
|
|
11394
11450
|
> **list**(`current`): [`IInfo`](../interfaces/IInfo.md)[]
|
|
11395
11451
|
|
|
11396
|
-
Defined in: [lib/command.ts:
|
|
11452
|
+
Defined in: [lib/command.ts:110](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L110)
|
|
11397
11453
|
|
|
11398
11454
|
获取独立元数据和当前状态,不导出业务函数
|
|
11399
11455
|
|
|
@@ -11424,7 +11480,7 @@ lib/command/functions/listTasks.md
|
|
|
11424
11480
|
|
|
11425
11481
|
> **listTasks**(): `object`[]
|
|
11426
11482
|
|
|
11427
|
-
Defined in: [lib/command.ts:
|
|
11483
|
+
Defined in: [lib/command.ts:118](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L118)
|
|
11428
11484
|
|
|
11429
11485
|
获取仍可调用的 App 标识与名称,供网页及 Native 代理发现目标
|
|
11430
11486
|
|
|
@@ -11447,7 +11503,7 @@ lib/command/functions/register.md
|
|
|
11447
11503
|
|
|
11448
11504
|
> **register**\<`T`\>(`current`, `definition`): `boolean`
|
|
11449
11505
|
|
|
11450
|
-
Defined in: [lib/command.ts:
|
|
11506
|
+
Defined in: [lib/command.ts:68](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L68)
|
|
11451
11507
|
|
|
11452
11508
|
注册命令;重复名称、不支持的 schema 或已销毁的实例返回 false
|
|
11453
11509
|
|
|
@@ -11477,6 +11533,43 @@ Defined in: [lib/command.ts:254](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11477
11533
|
|
|
11478
11534
|
是否注册成功
|
|
11479
11535
|
|
|
11536
|
+
lib/command/functions/releaseFile.md
|
|
11537
|
+
---
|
|
11538
|
+
|
|
11539
|
+
[**Documents for clickgo**](../../../index.md)
|
|
11540
|
+
|
|
11541
|
+
***
|
|
11542
|
+
|
|
11543
|
+
[Documents for clickgo](../../../index.md) / [lib/command](../index.md) / releaseFile
|
|
11544
|
+
|
|
11545
|
+
# Function: releaseFile()
|
|
11546
|
+
|
|
11547
|
+
> **releaseFile**(`current`, `fileId`): `boolean`
|
|
11548
|
+
|
|
11549
|
+
Defined in: [lib/command.ts:58](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L58)
|
|
11550
|
+
|
|
11551
|
+
主动释放旧导出的缓存,释放后代理不能继续读取;不删除磁盘文件
|
|
11552
|
+
|
|
11553
|
+
## Parameters
|
|
11554
|
+
|
|
11555
|
+
### current
|
|
11556
|
+
|
|
11557
|
+
[`TCurrent`](../../core/type-aliases/TCurrent.md)
|
|
11558
|
+
|
|
11559
|
+
文件所属的 App/Form/Panel,Form/Panel 只能释放自身范围
|
|
11560
|
+
|
|
11561
|
+
### fileId
|
|
11562
|
+
|
|
11563
|
+
`string`
|
|
11564
|
+
|
|
11565
|
+
先前交付的文件标识
|
|
11566
|
+
|
|
11567
|
+
## Returns
|
|
11568
|
+
|
|
11569
|
+
`boolean`
|
|
11570
|
+
|
|
11571
|
+
是否找到并释放,已释放或不属于当前范围为 false
|
|
11572
|
+
|
|
11480
11573
|
lib/command/functions/showPalette.md
|
|
11481
11574
|
---
|
|
11482
11575
|
|
|
@@ -11527,9 +11620,9 @@ lib/command/functions/success.md
|
|
|
11527
11620
|
|
|
11528
11621
|
# Function: success()
|
|
11529
11622
|
|
|
11530
|
-
> **success**\<`T`\>(`data`): [`TResult`](../type-aliases/TResult.md)\<`T`\>
|
|
11623
|
+
> **success**\<`T`\>(`data`, `files?`): [`TResult`](../type-aliases/TResult.md)\<`T`\>
|
|
11531
11624
|
|
|
11532
|
-
Defined in: [lib/command.ts:
|
|
11625
|
+
Defined in: [lib/command.ts:38](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L38)
|
|
11533
11626
|
|
|
11534
11627
|
构造成功结果
|
|
11535
11628
|
|
|
@@ -11547,6 +11640,12 @@ Defined in: [lib/command.ts:193](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11547
11640
|
|
|
11548
11641
|
可跨入口传输的 JSON 数据
|
|
11549
11642
|
|
|
11643
|
+
### files?
|
|
11644
|
+
|
|
11645
|
+
[`IFileInfo`](../interfaces/IFileInfo.md)[]
|
|
11646
|
+
|
|
11647
|
+
本次命令明确交付的框架文件,可省略;不能传入其他 App 的文件
|
|
11648
|
+
|
|
11550
11649
|
## Returns
|
|
11551
11650
|
|
|
11552
11651
|
[`TResult`](../type-aliases/TResult.md)\<`T`\>
|
|
@@ -11566,7 +11665,7 @@ lib/command/functions/unregister.md
|
|
|
11566
11665
|
|
|
11567
11666
|
> **unregister**(`current`, `name`): `boolean`
|
|
11568
11667
|
|
|
11569
|
-
Defined in: [lib/command.ts:
|
|
11668
|
+
Defined in: [lib/command.ts:80](https://github.com/maiyun/clickgo/blob/master/dist/lib/command.ts#L80)
|
|
11570
11669
|
|
|
11571
11670
|
取消尚在执行的命令并解除注册;取消是协作式,不回滚已产生的业务效果
|
|
11572
11671
|
|
|
@@ -11608,6 +11707,9 @@ lib/command/index.md
|
|
|
11608
11707
|
- [IBridge](interfaces/IBridge.md)
|
|
11609
11708
|
- [IContext](interfaces/IContext.md)
|
|
11610
11709
|
- [IDefinition](interfaces/IDefinition.md)
|
|
11710
|
+
- [IFileChunk](interfaces/IFileChunk.md)
|
|
11711
|
+
- [IFileInfo](interfaces/IFileInfo.md)
|
|
11712
|
+
- [IFileOptions](interfaces/IFileOptions.md)
|
|
11611
11713
|
- [IInfo](interfaces/IInfo.md)
|
|
11612
11714
|
- [IMetadata](interfaces/IMetadata.md)
|
|
11613
11715
|
- [IPageBridge](interfaces/IPageBridge.md)
|
|
@@ -11637,6 +11739,7 @@ lib/command/index.md
|
|
|
11637
11739
|
- [list](functions/list.md)
|
|
11638
11740
|
- [listTasks](functions/listTasks.md)
|
|
11639
11741
|
- [register](functions/register.md)
|
|
11742
|
+
- [releaseFile](functions/releaseFile.md)
|
|
11640
11743
|
- [showPalette](functions/showPalette.md)
|
|
11641
11744
|
- [success](functions/success.md)
|
|
11642
11745
|
- [unregister](functions/unregister.md)
|
|
@@ -11652,7 +11755,7 @@ lib/command/interfaces/IAgentInfo.md
|
|
|
11652
11755
|
|
|
11653
11756
|
# Interface: IAgentInfo
|
|
11654
11757
|
|
|
11655
|
-
Defined in: [lib/command.ts:
|
|
11758
|
+
Defined in: [lib/command/types.ts:134](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L134)
|
|
11656
11759
|
|
|
11657
11760
|
可展示或导出的接入信息;命令列表始终从对应入口实时查询
|
|
11658
11761
|
|
|
@@ -11662,7 +11765,7 @@ Defined in: [lib/command.ts:132](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11662
11765
|
|
|
11663
11766
|
> **apps**: `object`[]
|
|
11664
11767
|
|
|
11665
|
-
Defined in: [lib/command.ts:
|
|
11768
|
+
Defined in: [lib/command/types.ts:136](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L136)
|
|
11666
11769
|
|
|
11667
11770
|
#### id
|
|
11668
11771
|
|
|
@@ -11678,7 +11781,7 @@ Defined in: [lib/command.ts:134](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11678
11781
|
|
|
11679
11782
|
> **browser**: `object`
|
|
11680
11783
|
|
|
11681
|
-
Defined in: [lib/command.ts:
|
|
11784
|
+
Defined in: [lib/command/types.ts:138](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L138)
|
|
11682
11785
|
|
|
11683
11786
|
#### api
|
|
11684
11787
|
|
|
@@ -11694,7 +11797,7 @@ Defined in: [lib/command.ts:136](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11694
11797
|
|
|
11695
11798
|
> **http**: [`IMcpInfo`](../../native/interfaces/IMcpInfo.md) \| `null`
|
|
11696
11799
|
|
|
11697
|
-
Defined in: [lib/command.ts:
|
|
11800
|
+
Defined in: [lib/command/types.ts:150](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L150)
|
|
11698
11801
|
|
|
11699
11802
|
只有显式导出且通过 root 检查时才包含 HTTP 凭据
|
|
11700
11803
|
|
|
@@ -11704,7 +11807,7 @@ Defined in: [lib/command.ts:148](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11704
11807
|
|
|
11705
11808
|
> **native**: [`ICommandEntry`](../../native/interfaces/ICommandEntry.md) \| `null`
|
|
11706
11809
|
|
|
11707
|
-
Defined in: [lib/command.ts:
|
|
11810
|
+
Defined in: [lib/command/types.ts:148](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L148)
|
|
11708
11811
|
|
|
11709
11812
|
***
|
|
11710
11813
|
|
|
@@ -11712,7 +11815,7 @@ Defined in: [lib/command.ts:146](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11712
11815
|
|
|
11713
11816
|
> **schemaVersion**: `1`
|
|
11714
11817
|
|
|
11715
|
-
Defined in: [lib/command.ts:
|
|
11818
|
+
Defined in: [lib/command/types.ts:135](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L135)
|
|
11716
11819
|
|
|
11717
11820
|
***
|
|
11718
11821
|
|
|
@@ -11720,7 +11823,7 @@ Defined in: [lib/command.ts:133](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11720
11823
|
|
|
11721
11824
|
> **targetTaskId**: `string` \| `null`
|
|
11722
11825
|
|
|
11723
|
-
Defined in: [lib/command.ts:
|
|
11826
|
+
Defined in: [lib/command/types.ts:137](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L137)
|
|
11724
11827
|
|
|
11725
11828
|
***
|
|
11726
11829
|
|
|
@@ -11728,7 +11831,7 @@ Defined in: [lib/command.ts:135](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11728
11831
|
|
|
11729
11832
|
> **webMcp**: `object`
|
|
11730
11833
|
|
|
11731
|
-
Defined in: [lib/command.ts:
|
|
11834
|
+
Defined in: [lib/command/types.ts:139](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L139)
|
|
11732
11835
|
|
|
11733
11836
|
#### publishedTaskIds
|
|
11734
11837
|
|
|
@@ -11763,7 +11866,7 @@ lib/command/interfaces/IAgentOptions.md
|
|
|
11763
11866
|
|
|
11764
11867
|
# Interface: IAgentOptions
|
|
11765
11868
|
|
|
11766
|
-
Defined in: [lib/command.ts:
|
|
11869
|
+
Defined in: [lib/command/types.ts:122](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L122)
|
|
11767
11870
|
|
|
11768
11871
|
统一接入说明的生成选项;默认不读取或包含 HTTP 凭据
|
|
11769
11872
|
|
|
@@ -11773,7 +11876,7 @@ Defined in: [lib/command.ts:120](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11773
11876
|
|
|
11774
11877
|
> `optional` **includeMcpCredentials?**: `boolean`
|
|
11775
11878
|
|
|
11776
|
-
Defined in: [lib/command.ts:
|
|
11879
|
+
Defined in: [lib/command/types.ts:124](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L124)
|
|
11777
11880
|
|
|
11778
11881
|
仅供应用主动导出 HTTP 连接设置,仍要求当前 App 已有 root 权限
|
|
11779
11882
|
|
|
@@ -11788,7 +11891,7 @@ lib/command/interfaces/IBridge.md
|
|
|
11788
11891
|
|
|
11789
11892
|
# Interface: IBridge
|
|
11790
11893
|
|
|
11791
|
-
Defined in: [lib/command.ts:
|
|
11894
|
+
Defined in: [lib/command/types.ts:105](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L105)
|
|
11792
11895
|
|
|
11793
11896
|
绑定一个应用实例,只能调用该实例明确公开的命令
|
|
11794
11897
|
|
|
@@ -11798,7 +11901,7 @@ Defined in: [lib/command.ts:103](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11798
11901
|
|
|
11799
11902
|
> **execute**: (`name`, `args?`, `options?`) => `Promise`\<[`TResult`](../type-aliases/TResult.md)\<[`TJson`](../../tool/type-aliases/TJson.md)\>\>
|
|
11800
11903
|
|
|
11801
|
-
Defined in: [lib/command.ts:
|
|
11904
|
+
Defined in: [lib/command/types.ts:108](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L108)
|
|
11802
11905
|
|
|
11803
11906
|
#### Parameters
|
|
11804
11907
|
|
|
@@ -11826,7 +11929,7 @@ Defined in: [lib/command.ts:106](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11826
11929
|
|
|
11827
11930
|
> **list**: () => [`IInfo`](IInfo.md)[]
|
|
11828
11931
|
|
|
11829
|
-
Defined in: [lib/command.ts:
|
|
11932
|
+
Defined in: [lib/command/types.ts:107](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L107)
|
|
11830
11933
|
|
|
11831
11934
|
#### Returns
|
|
11832
11935
|
|
|
@@ -11838,7 +11941,7 @@ Defined in: [lib/command.ts:105](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
11838
11941
|
|
|
11839
11942
|
> **taskId**: `string`
|
|
11840
11943
|
|
|
11841
|
-
Defined in: [lib/command.ts:
|
|
11944
|
+
Defined in: [lib/command/types.ts:106](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L106)
|
|
11842
11945
|
|
|
11843
11946
|
lib/command/interfaces/IContext.md
|
|
11844
11947
|
---
|
|
@@ -11851,17 +11954,48 @@ lib/command/interfaces/IContext.md
|
|
|
11851
11954
|
|
|
11852
11955
|
# Interface: IContext
|
|
11853
11956
|
|
|
11854
|
-
Defined in: [lib/command.ts:
|
|
11957
|
+
Defined in: [lib/command/types.ts:45](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L45)
|
|
11855
11958
|
|
|
11856
11959
|
执行来源仅用于展示与记录,不是授权凭证
|
|
11857
11960
|
|
|
11858
11961
|
## Properties
|
|
11859
11962
|
|
|
11963
|
+
### createFile
|
|
11964
|
+
|
|
11965
|
+
> **createFile**: (`blob`, `options`) => `false` \| [`IFileInfo`](IFileInfo.md)
|
|
11966
|
+
|
|
11967
|
+
Defined in: [lib/command/types.ts:58](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L58)
|
|
11968
|
+
|
|
11969
|
+
保留已生成文件;用 success(data, [file]) 明确交付,不读取路径或重新生成
|
|
11970
|
+
|
|
11971
|
+
#### Parameters
|
|
11972
|
+
|
|
11973
|
+
##### blob
|
|
11974
|
+
|
|
11975
|
+
`Blob`
|
|
11976
|
+
|
|
11977
|
+
原文件,单份最多 64 MiB;每个 App 最多 8 份、合计 128 MiB
|
|
11978
|
+
|
|
11979
|
+
##### options
|
|
11980
|
+
|
|
11981
|
+
[`IFileOptions`](IFileOptions.md)
|
|
11982
|
+
|
|
11983
|
+
文件名及可选 MIME,默认使用 Blob.type 或 application/octet-stream
|
|
11984
|
+
|
|
11985
|
+
#### Returns
|
|
11986
|
+
|
|
11987
|
+
`false` \| [`IFileInfo`](IFileInfo.md)
|
|
11988
|
+
|
|
11989
|
+
十分钟有效的独立句柄,随所属范围销毁;参数/容量无效返回 false
|
|
11990
|
+
仅在本次执行中有效;失败、取消、无效输出及未交付的文件自动释放,私有命令不公开文件
|
|
11991
|
+
|
|
11992
|
+
***
|
|
11993
|
+
|
|
11860
11994
|
### formId
|
|
11861
11995
|
|
|
11862
11996
|
> **formId**: `string`
|
|
11863
11997
|
|
|
11864
|
-
Defined in: [lib/command.ts:
|
|
11998
|
+
Defined in: [lib/command/types.ts:47](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L47)
|
|
11865
11999
|
|
|
11866
12000
|
***
|
|
11867
12001
|
|
|
@@ -11869,7 +12003,7 @@ Defined in: [lib/command.ts:53](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11869
12003
|
|
|
11870
12004
|
> **panelId**: `string`
|
|
11871
12005
|
|
|
11872
|
-
Defined in: [lib/command.ts:
|
|
12006
|
+
Defined in: [lib/command/types.ts:48](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L48)
|
|
11873
12007
|
|
|
11874
12008
|
***
|
|
11875
12009
|
|
|
@@ -11877,7 +12011,7 @@ Defined in: [lib/command.ts:54](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11877
12011
|
|
|
11878
12012
|
> **signal**: `AbortSignal`
|
|
11879
12013
|
|
|
11880
|
-
Defined in: [lib/command.ts:
|
|
12014
|
+
Defined in: [lib/command/types.ts:50](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L50)
|
|
11881
12015
|
|
|
11882
12016
|
***
|
|
11883
12017
|
|
|
@@ -11885,7 +12019,7 @@ Defined in: [lib/command.ts:56](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11885
12019
|
|
|
11886
12020
|
> **source**: `"user"` \| `"agent"`
|
|
11887
12021
|
|
|
11888
|
-
Defined in: [lib/command.ts:
|
|
12022
|
+
Defined in: [lib/command/types.ts:49](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L49)
|
|
11889
12023
|
|
|
11890
12024
|
***
|
|
11891
12025
|
|
|
@@ -11893,7 +12027,7 @@ Defined in: [lib/command.ts:55](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11893
12027
|
|
|
11894
12028
|
> **taskId**: `string`
|
|
11895
12029
|
|
|
11896
|
-
Defined in: [lib/command.ts:
|
|
12030
|
+
Defined in: [lib/command/types.ts:46](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L46)
|
|
11897
12031
|
|
|
11898
12032
|
lib/command/interfaces/IDefinition.md
|
|
11899
12033
|
---
|
|
@@ -11906,7 +12040,7 @@ lib/command/interfaces/IDefinition.md
|
|
|
11906
12040
|
|
|
11907
12041
|
# Interface: IDefinition\<T\>
|
|
11908
12042
|
|
|
11909
|
-
Defined in: [lib/command.ts:
|
|
12043
|
+
Defined in: [lib/command/types.ts:81](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L81)
|
|
11910
12044
|
|
|
11911
12045
|
应用声明一次,界面、浏览器代理和 Native 适配器共享执行函数
|
|
11912
12046
|
|
|
@@ -11926,7 +12060,7 @@ Defined in: [lib/command.ts:79](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11926
12060
|
|
|
11927
12061
|
> `optional` **annotations?**: `object`
|
|
11928
12062
|
|
|
11929
|
-
Defined in: [lib/command.ts:
|
|
12063
|
+
Defined in: [lib/command/types.ts:69](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L69)
|
|
11930
12064
|
|
|
11931
12065
|
行为说明,不代替校验或授权
|
|
11932
12066
|
|
|
@@ -11966,7 +12100,7 @@ WebMCP 的重要或不可逆现实效果说明
|
|
|
11966
12100
|
|
|
11967
12101
|
> `optional` **concurrent?**: `boolean`
|
|
11968
12102
|
|
|
11969
|
-
Defined in: [lib/command.ts:
|
|
12103
|
+
Defined in: [lib/command/types.ts:85](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L85)
|
|
11970
12104
|
|
|
11971
12105
|
默认拒绝同一命令并发;业务确认可并行时才开启
|
|
11972
12106
|
|
|
@@ -11976,7 +12110,7 @@ Defined in: [lib/command.ts:83](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11976
12110
|
|
|
11977
12111
|
> **description**: `string`
|
|
11978
12112
|
|
|
11979
|
-
Defined in: [lib/command.ts:
|
|
12113
|
+
Defined in: [lib/command/types.ts:65](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L65)
|
|
11980
12114
|
|
|
11981
12115
|
#### Inherited from
|
|
11982
12116
|
|
|
@@ -11988,7 +12122,7 @@ Defined in: [lib/command.ts:63](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
11988
12122
|
|
|
11989
12123
|
> `optional` **enabled?**: () => `string` \| `boolean`
|
|
11990
12124
|
|
|
11991
|
-
Defined in: [lib/command.ts:
|
|
12125
|
+
Defined in: [lib/command/types.ts:89](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L89)
|
|
11992
12126
|
|
|
11993
12127
|
true 为可用,false 或原因文本为不可用;每次执行重新检查
|
|
11994
12128
|
|
|
@@ -12002,7 +12136,7 @@ true 为可用,false 或原因文本为不可用;每次执行重新检查
|
|
|
12002
12136
|
|
|
12003
12137
|
> **execute**: (`args`, `context`) => [`TResult`](../type-aliases/TResult.md)\<[`TJson`](../../tool/type-aliases/TJson.md)\> \| `Promise`\<[`TResult`](../type-aliases/TResult.md)\<[`TJson`](../../tool/type-aliases/TJson.md)\>\>
|
|
12004
12138
|
|
|
12005
|
-
Defined in: [lib/command.ts:
|
|
12139
|
+
Defined in: [lib/command/types.ts:90](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L90)
|
|
12006
12140
|
|
|
12007
12141
|
#### Parameters
|
|
12008
12142
|
|
|
@@ -12024,7 +12158,7 @@ Defined in: [lib/command.ts:88](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12024
12158
|
|
|
12025
12159
|
> `optional` **exposed?**: `boolean`
|
|
12026
12160
|
|
|
12027
|
-
Defined in: [lib/command.ts:
|
|
12161
|
+
Defined in: [lib/command/types.ts:83](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L83)
|
|
12028
12162
|
|
|
12029
12163
|
明确允许代理发现并调用;默认只允许应用内部调用
|
|
12030
12164
|
|
|
@@ -12034,7 +12168,7 @@ Defined in: [lib/command.ts:81](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12034
12168
|
|
|
12035
12169
|
> **inputSchema**: [`ISchema`](ISchema.md) & `object`
|
|
12036
12170
|
|
|
12037
|
-
Defined in: [lib/command.ts:
|
|
12171
|
+
Defined in: [lib/command/types.ts:66](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L66)
|
|
12038
12172
|
|
|
12039
12173
|
#### Type Declaration
|
|
12040
12174
|
|
|
@@ -12052,7 +12186,7 @@ Defined in: [lib/command.ts:64](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12052
12186
|
|
|
12053
12187
|
> **name**: `string`
|
|
12054
12188
|
|
|
12055
|
-
Defined in: [lib/command.ts:
|
|
12189
|
+
Defined in: [lib/command/types.ts:63](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L63)
|
|
12056
12190
|
|
|
12057
12191
|
#### Inherited from
|
|
12058
12192
|
|
|
@@ -12064,7 +12198,7 @@ Defined in: [lib/command.ts:61](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12064
12198
|
|
|
12065
12199
|
> `optional` **outputSchema?**: [`ISchema`](ISchema.md)
|
|
12066
12200
|
|
|
12067
|
-
Defined in: [lib/command.ts:
|
|
12201
|
+
Defined in: [lib/command/types.ts:67](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L67)
|
|
12068
12202
|
|
|
12069
12203
|
#### Inherited from
|
|
12070
12204
|
|
|
@@ -12076,7 +12210,7 @@ Defined in: [lib/command.ts:65](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12076
12210
|
|
|
12077
12211
|
> `optional` **permissions?**: `string`[]
|
|
12078
12212
|
|
|
12079
|
-
Defined in: [lib/command.ts:
|
|
12213
|
+
Defined in: [lib/command/types.ts:87](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L87)
|
|
12080
12214
|
|
|
12081
12215
|
必须已经取得的框架权限;执行入口不弹授权窗
|
|
12082
12216
|
|
|
@@ -12086,12 +12220,187 @@ Defined in: [lib/command.ts:85](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12086
12220
|
|
|
12087
12221
|
> `optional` **title?**: `string`
|
|
12088
12222
|
|
|
12089
|
-
Defined in: [lib/command.ts:
|
|
12223
|
+
Defined in: [lib/command/types.ts:64](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L64)
|
|
12090
12224
|
|
|
12091
12225
|
#### Inherited from
|
|
12092
12226
|
|
|
12093
12227
|
[`IMetadata`](IMetadata.md).[`title`](IMetadata.md#title)
|
|
12094
12228
|
|
|
12229
|
+
lib/command/interfaces/IFileChunk.md
|
|
12230
|
+
---
|
|
12231
|
+
|
|
12232
|
+
[**Documents for clickgo**](../../../index.md)
|
|
12233
|
+
|
|
12234
|
+
***
|
|
12235
|
+
|
|
12236
|
+
[Documents for clickgo](../../../index.md) / [lib/command](../index.md) / IFileChunk
|
|
12237
|
+
|
|
12238
|
+
# Interface: IFileChunk
|
|
12239
|
+
|
|
12240
|
+
Defined in: [lib/command/file.ts:48](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L48)
|
|
12241
|
+
|
|
12242
|
+
每段携带同一份快照信息,便于客户端校验文件及交付状态
|
|
12243
|
+
|
|
12244
|
+
## Properties
|
|
12245
|
+
|
|
12246
|
+
### data
|
|
12247
|
+
|
|
12248
|
+
> **data**: `string`
|
|
12249
|
+
|
|
12250
|
+
Defined in: [lib/command/file.ts:53](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L53)
|
|
12251
|
+
|
|
12252
|
+
***
|
|
12253
|
+
|
|
12254
|
+
### encoding
|
|
12255
|
+
|
|
12256
|
+
> **encoding**: `"base64"`
|
|
12257
|
+
|
|
12258
|
+
Defined in: [lib/command/file.ts:52](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L52)
|
|
12259
|
+
|
|
12260
|
+
***
|
|
12261
|
+
|
|
12262
|
+
### file
|
|
12263
|
+
|
|
12264
|
+
> **file**: [`IFileInfo`](IFileInfo.md)
|
|
12265
|
+
|
|
12266
|
+
Defined in: [lib/command/file.ts:49](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L49)
|
|
12267
|
+
|
|
12268
|
+
***
|
|
12269
|
+
|
|
12270
|
+
### nextOffset
|
|
12271
|
+
|
|
12272
|
+
> **nextOffset**: `number` \| `null`
|
|
12273
|
+
|
|
12274
|
+
Defined in: [lib/command/file.ts:51](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L51)
|
|
12275
|
+
|
|
12276
|
+
***
|
|
12277
|
+
|
|
12278
|
+
### offset
|
|
12279
|
+
|
|
12280
|
+
> **offset**: `number`
|
|
12281
|
+
|
|
12282
|
+
Defined in: [lib/command/file.ts:50](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L50)
|
|
12283
|
+
|
|
12284
|
+
lib/command/interfaces/IFileInfo.md
|
|
12285
|
+
---
|
|
12286
|
+
|
|
12287
|
+
[**Documents for clickgo**](../../../index.md)
|
|
12288
|
+
|
|
12289
|
+
***
|
|
12290
|
+
|
|
12291
|
+
[Documents for clickgo](../../../index.md) / [lib/command](../index.md) / IFileInfo
|
|
12292
|
+
|
|
12293
|
+
# Interface: IFileInfo
|
|
12294
|
+
|
|
12295
|
+
Defined in: [lib/command/file.ts:28](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L28)
|
|
12296
|
+
|
|
12297
|
+
文件快照元数据;时间为 Unix 毫秒,URI 仅在所属页面生命周期内有效
|
|
12298
|
+
|
|
12299
|
+
## Properties
|
|
12300
|
+
|
|
12301
|
+
### byteLength
|
|
12302
|
+
|
|
12303
|
+
> **byteLength**: `number`
|
|
12304
|
+
|
|
12305
|
+
Defined in: [lib/command/file.ts:32](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L32)
|
|
12306
|
+
|
|
12307
|
+
***
|
|
12308
|
+
|
|
12309
|
+
### createdAt
|
|
12310
|
+
|
|
12311
|
+
> **createdAt**: `number`
|
|
12312
|
+
|
|
12313
|
+
Defined in: [lib/command/file.ts:33](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L33)
|
|
12314
|
+
|
|
12315
|
+
***
|
|
12316
|
+
|
|
12317
|
+
### expiresAt
|
|
12318
|
+
|
|
12319
|
+
> **expiresAt**: `number`
|
|
12320
|
+
|
|
12321
|
+
Defined in: [lib/command/file.ts:34](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L34)
|
|
12322
|
+
|
|
12323
|
+
***
|
|
12324
|
+
|
|
12325
|
+
### fileId
|
|
12326
|
+
|
|
12327
|
+
> **fileId**: `string`
|
|
12328
|
+
|
|
12329
|
+
Defined in: [lib/command/file.ts:29](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L29)
|
|
12330
|
+
|
|
12331
|
+
***
|
|
12332
|
+
|
|
12333
|
+
### fileName
|
|
12334
|
+
|
|
12335
|
+
> **fileName**: `string`
|
|
12336
|
+
|
|
12337
|
+
Defined in: [lib/command/file.ts:30](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L30)
|
|
12338
|
+
|
|
12339
|
+
***
|
|
12340
|
+
|
|
12341
|
+
### mimeType
|
|
12342
|
+
|
|
12343
|
+
> **mimeType**: `string`
|
|
12344
|
+
|
|
12345
|
+
Defined in: [lib/command/file.ts:31](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L31)
|
|
12346
|
+
|
|
12347
|
+
***
|
|
12348
|
+
|
|
12349
|
+
### readChunkSize
|
|
12350
|
+
|
|
12351
|
+
> **readChunkSize**: `number`
|
|
12352
|
+
|
|
12353
|
+
Defined in: [lib/command/file.ts:37](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L37)
|
|
12354
|
+
|
|
12355
|
+
***
|
|
12356
|
+
|
|
12357
|
+
### readCommand
|
|
12358
|
+
|
|
12359
|
+
> **readCommand**: `string`
|
|
12360
|
+
|
|
12361
|
+
Defined in: [lib/command/file.ts:36](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L36)
|
|
12362
|
+
|
|
12363
|
+
***
|
|
12364
|
+
|
|
12365
|
+
### uri
|
|
12366
|
+
|
|
12367
|
+
> **uri**: `string`
|
|
12368
|
+
|
|
12369
|
+
Defined in: [lib/command/file.ts:35](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L35)
|
|
12370
|
+
|
|
12371
|
+
lib/command/interfaces/IFileOptions.md
|
|
12372
|
+
---
|
|
12373
|
+
|
|
12374
|
+
[**Documents for clickgo**](../../../index.md)
|
|
12375
|
+
|
|
12376
|
+
***
|
|
12377
|
+
|
|
12378
|
+
[Documents for clickgo](../../../index.md) / [lib/command](../index.md) / IFileOptions
|
|
12379
|
+
|
|
12380
|
+
# Interface: IFileOptions
|
|
12381
|
+
|
|
12382
|
+
Defined in: [lib/command/file.ts:21](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L21)
|
|
12383
|
+
|
|
12384
|
+
发布的是已生成 Blob,不读取路径、不上传或重新生成文件
|
|
12385
|
+
|
|
12386
|
+
## Properties
|
|
12387
|
+
|
|
12388
|
+
### fileName
|
|
12389
|
+
|
|
12390
|
+
> **fileName**: `string`
|
|
12391
|
+
|
|
12392
|
+
Defined in: [lib/command/file.ts:22](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L22)
|
|
12393
|
+
|
|
12394
|
+
***
|
|
12395
|
+
|
|
12396
|
+
### mimeType?
|
|
12397
|
+
|
|
12398
|
+
> `optional` **mimeType?**: `string`
|
|
12399
|
+
|
|
12400
|
+
Defined in: [lib/command/file.ts:24](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/file.ts#L24)
|
|
12401
|
+
|
|
12402
|
+
默认使用 Blob.type;为空时使用 application/octet-stream
|
|
12403
|
+
|
|
12095
12404
|
lib/command/interfaces/IInfo.md
|
|
12096
12405
|
---
|
|
12097
12406
|
|
|
@@ -12103,7 +12412,7 @@ lib/command/interfaces/IInfo.md
|
|
|
12103
12412
|
|
|
12104
12413
|
# Interface: IInfo
|
|
12105
12414
|
|
|
12106
|
-
Defined in: [lib/command.ts:
|
|
12415
|
+
Defined in: [lib/command/types.ts:94](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L94)
|
|
12107
12416
|
|
|
12108
12417
|
不包含函数或内部对象的独立快照
|
|
12109
12418
|
|
|
@@ -12117,7 +12426,7 @@ Defined in: [lib/command.ts:92](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12117
12426
|
|
|
12118
12427
|
> `optional` **annotations?**: `object`
|
|
12119
12428
|
|
|
12120
|
-
Defined in: [lib/command.ts:
|
|
12429
|
+
Defined in: [lib/command/types.ts:69](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L69)
|
|
12121
12430
|
|
|
12122
12431
|
行为说明,不代替校验或授权
|
|
12123
12432
|
|
|
@@ -12157,7 +12466,7 @@ WebMCP 的重要或不可逆现实效果说明
|
|
|
12157
12466
|
|
|
12158
12467
|
> **description**: `string`
|
|
12159
12468
|
|
|
12160
|
-
Defined in: [lib/command.ts:
|
|
12469
|
+
Defined in: [lib/command/types.ts:65](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L65)
|
|
12161
12470
|
|
|
12162
12471
|
#### Inherited from
|
|
12163
12472
|
|
|
@@ -12169,7 +12478,7 @@ Defined in: [lib/command.ts:63](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12169
12478
|
|
|
12170
12479
|
> **disabledReason**: `string`
|
|
12171
12480
|
|
|
12172
|
-
Defined in: [lib/command.ts:
|
|
12481
|
+
Defined in: [lib/command/types.ts:100](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L100)
|
|
12173
12482
|
|
|
12174
12483
|
***
|
|
12175
12484
|
|
|
@@ -12177,7 +12486,7 @@ Defined in: [lib/command.ts:98](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12177
12486
|
|
|
12178
12487
|
> **enabled**: `boolean`
|
|
12179
12488
|
|
|
12180
|
-
Defined in: [lib/command.ts:
|
|
12489
|
+
Defined in: [lib/command/types.ts:99](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L99)
|
|
12181
12490
|
|
|
12182
12491
|
***
|
|
12183
12492
|
|
|
@@ -12185,7 +12494,7 @@ Defined in: [lib/command.ts:97](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12185
12494
|
|
|
12186
12495
|
> **exposed**: `boolean`
|
|
12187
12496
|
|
|
12188
|
-
Defined in: [lib/command.ts:
|
|
12497
|
+
Defined in: [lib/command/types.ts:98](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L98)
|
|
12189
12498
|
|
|
12190
12499
|
***
|
|
12191
12500
|
|
|
@@ -12193,7 +12502,7 @@ Defined in: [lib/command.ts:96](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12193
12502
|
|
|
12194
12503
|
> **formId**: `string`
|
|
12195
12504
|
|
|
12196
|
-
Defined in: [lib/command.ts:
|
|
12505
|
+
Defined in: [lib/command/types.ts:96](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L96)
|
|
12197
12506
|
|
|
12198
12507
|
***
|
|
12199
12508
|
|
|
@@ -12201,7 +12510,7 @@ Defined in: [lib/command.ts:94](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12201
12510
|
|
|
12202
12511
|
> **inputSchema**: [`ISchema`](ISchema.md) & `object`
|
|
12203
12512
|
|
|
12204
|
-
Defined in: [lib/command.ts:
|
|
12513
|
+
Defined in: [lib/command/types.ts:66](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L66)
|
|
12205
12514
|
|
|
12206
12515
|
#### Type Declaration
|
|
12207
12516
|
|
|
@@ -12219,7 +12528,7 @@ Defined in: [lib/command.ts:64](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12219
12528
|
|
|
12220
12529
|
> **name**: `string`
|
|
12221
12530
|
|
|
12222
|
-
Defined in: [lib/command.ts:
|
|
12531
|
+
Defined in: [lib/command/types.ts:63](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L63)
|
|
12223
12532
|
|
|
12224
12533
|
#### Inherited from
|
|
12225
12534
|
|
|
@@ -12231,7 +12540,7 @@ Defined in: [lib/command.ts:61](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12231
12540
|
|
|
12232
12541
|
> `optional` **outputSchema?**: [`ISchema`](ISchema.md)
|
|
12233
12542
|
|
|
12234
|
-
Defined in: [lib/command.ts:
|
|
12543
|
+
Defined in: [lib/command/types.ts:67](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L67)
|
|
12235
12544
|
|
|
12236
12545
|
#### Inherited from
|
|
12237
12546
|
|
|
@@ -12243,7 +12552,7 @@ Defined in: [lib/command.ts:65](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12243
12552
|
|
|
12244
12553
|
> **panelId**: `string`
|
|
12245
12554
|
|
|
12246
|
-
Defined in: [lib/command.ts:
|
|
12555
|
+
Defined in: [lib/command/types.ts:97](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L97)
|
|
12247
12556
|
|
|
12248
12557
|
***
|
|
12249
12558
|
|
|
@@ -12251,7 +12560,7 @@ Defined in: [lib/command.ts:95](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12251
12560
|
|
|
12252
12561
|
> **running**: `number`
|
|
12253
12562
|
|
|
12254
|
-
Defined in: [lib/command.ts:
|
|
12563
|
+
Defined in: [lib/command/types.ts:101](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L101)
|
|
12255
12564
|
|
|
12256
12565
|
***
|
|
12257
12566
|
|
|
@@ -12259,7 +12568,7 @@ Defined in: [lib/command.ts:99](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12259
12568
|
|
|
12260
12569
|
> **taskId**: `string`
|
|
12261
12570
|
|
|
12262
|
-
Defined in: [lib/command.ts:
|
|
12571
|
+
Defined in: [lib/command/types.ts:95](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L95)
|
|
12263
12572
|
|
|
12264
12573
|
***
|
|
12265
12574
|
|
|
@@ -12267,7 +12576,7 @@ Defined in: [lib/command.ts:93](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12267
12576
|
|
|
12268
12577
|
> `optional` **title?**: `string`
|
|
12269
12578
|
|
|
12270
|
-
Defined in: [lib/command.ts:
|
|
12579
|
+
Defined in: [lib/command/types.ts:64](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L64)
|
|
12271
12580
|
|
|
12272
12581
|
#### Inherited from
|
|
12273
12582
|
|
|
@@ -12284,7 +12593,7 @@ lib/command/interfaces/IMetadata.md
|
|
|
12284
12593
|
|
|
12285
12594
|
# Interface: IMetadata
|
|
12286
12595
|
|
|
12287
|
-
Defined in: [lib/command.ts:
|
|
12596
|
+
Defined in: [lib/command/types.ts:62](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L62)
|
|
12288
12597
|
|
|
12289
12598
|
与 MCP 工具描述对齐的公开命令元数据
|
|
12290
12599
|
|
|
@@ -12299,7 +12608,7 @@ Defined in: [lib/command.ts:60](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12299
12608
|
|
|
12300
12609
|
> `optional` **annotations?**: `object`
|
|
12301
12610
|
|
|
12302
|
-
Defined in: [lib/command.ts:
|
|
12611
|
+
Defined in: [lib/command/types.ts:69](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L69)
|
|
12303
12612
|
|
|
12304
12613
|
行为说明,不代替校验或授权
|
|
12305
12614
|
|
|
@@ -12335,7 +12644,7 @@ WebMCP 的重要或不可逆现实效果说明
|
|
|
12335
12644
|
|
|
12336
12645
|
> **description**: `string`
|
|
12337
12646
|
|
|
12338
|
-
Defined in: [lib/command.ts:
|
|
12647
|
+
Defined in: [lib/command/types.ts:65](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L65)
|
|
12339
12648
|
|
|
12340
12649
|
***
|
|
12341
12650
|
|
|
@@ -12343,7 +12652,7 @@ Defined in: [lib/command.ts:63](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12343
12652
|
|
|
12344
12653
|
> **inputSchema**: [`ISchema`](ISchema.md) & `object`
|
|
12345
12654
|
|
|
12346
|
-
Defined in: [lib/command.ts:
|
|
12655
|
+
Defined in: [lib/command/types.ts:66](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L66)
|
|
12347
12656
|
|
|
12348
12657
|
#### Type Declaration
|
|
12349
12658
|
|
|
@@ -12357,7 +12666,7 @@ Defined in: [lib/command.ts:64](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12357
12666
|
|
|
12358
12667
|
> **name**: `string`
|
|
12359
12668
|
|
|
12360
|
-
Defined in: [lib/command.ts:
|
|
12669
|
+
Defined in: [lib/command/types.ts:63](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L63)
|
|
12361
12670
|
|
|
12362
12671
|
***
|
|
12363
12672
|
|
|
@@ -12365,7 +12674,7 @@ Defined in: [lib/command.ts:61](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12365
12674
|
|
|
12366
12675
|
> `optional` **outputSchema?**: [`ISchema`](ISchema.md)
|
|
12367
12676
|
|
|
12368
|
-
Defined in: [lib/command.ts:
|
|
12677
|
+
Defined in: [lib/command/types.ts:67](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L67)
|
|
12369
12678
|
|
|
12370
12679
|
***
|
|
12371
12680
|
|
|
@@ -12373,7 +12682,7 @@ Defined in: [lib/command.ts:65](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12373
12682
|
|
|
12374
12683
|
> `optional` **title?**: `string`
|
|
12375
12684
|
|
|
12376
|
-
Defined in: [lib/command.ts:
|
|
12685
|
+
Defined in: [lib/command/types.ts:64](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L64)
|
|
12377
12686
|
|
|
12378
12687
|
lib/command/interfaces/IPageBridge.md
|
|
12379
12688
|
---
|
|
@@ -12386,7 +12695,7 @@ lib/command/interfaces/IPageBridge.md
|
|
|
12386
12695
|
|
|
12387
12696
|
# Interface: IPageBridge
|
|
12388
12697
|
|
|
12389
|
-
Defined in: [lib/command.ts:
|
|
12698
|
+
Defined in: [lib/command/types.ts:112](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L112)
|
|
12390
12699
|
|
|
12391
12700
|
框架向网页发布的统一入口;按任务选择应用,只访问明确公开的命令
|
|
12392
12701
|
|
|
@@ -12396,7 +12705,7 @@ Defined in: [lib/command.ts:110](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
12396
12705
|
|
|
12397
12706
|
> **execute**: (`taskId`, `name`, `args?`, `options?`) => `Promise`\<[`TResult`](../type-aliases/TResult.md)\<[`TJson`](../../tool/type-aliases/TJson.md)\>\>
|
|
12398
12707
|
|
|
12399
|
-
Defined in: [lib/command.ts:
|
|
12708
|
+
Defined in: [lib/command/types.ts:117](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L117)
|
|
12400
12709
|
|
|
12401
12710
|
#### Parameters
|
|
12402
12711
|
|
|
@@ -12428,7 +12737,7 @@ Defined in: [lib/command.ts:115](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
12428
12737
|
|
|
12429
12738
|
> **getAgentGuide**: (`taskId?`) => `Promise`\<`string` \| `false` \| `null`\>
|
|
12430
12739
|
|
|
12431
|
-
Defined in: [lib/command.ts:
|
|
12740
|
+
Defined in: [lib/command/types.ts:114](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L114)
|
|
12432
12741
|
|
|
12433
12742
|
#### Parameters
|
|
12434
12743
|
|
|
@@ -12446,7 +12755,7 @@ Defined in: [lib/command.ts:112](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
12446
12755
|
|
|
12447
12756
|
> **getAgentInfo**: (`taskId?`) => `Promise`\<`false` \| [`IAgentInfo`](IAgentInfo.md) \| `null`\>
|
|
12448
12757
|
|
|
12449
|
-
Defined in: [lib/command.ts:
|
|
12758
|
+
Defined in: [lib/command/types.ts:113](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L113)
|
|
12450
12759
|
|
|
12451
12760
|
#### Parameters
|
|
12452
12761
|
|
|
@@ -12464,7 +12773,7 @@ Defined in: [lib/command.ts:111](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
12464
12773
|
|
|
12465
12774
|
> **list**: (`taskId`) => [`IInfo`](IInfo.md)[]
|
|
12466
12775
|
|
|
12467
|
-
Defined in: [lib/command.ts:
|
|
12776
|
+
Defined in: [lib/command/types.ts:116](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L116)
|
|
12468
12777
|
|
|
12469
12778
|
#### Parameters
|
|
12470
12779
|
|
|
@@ -12482,7 +12791,7 @@ Defined in: [lib/command.ts:114](https://github.com/maiyun/clickgo/blob/master/d
|
|
|
12482
12791
|
|
|
12483
12792
|
> **listTasks**: () => `object`[]
|
|
12484
12793
|
|
|
12485
|
-
Defined in: [lib/command.ts:
|
|
12794
|
+
Defined in: [lib/command/types.ts:115](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L115)
|
|
12486
12795
|
|
|
12487
12796
|
#### Returns
|
|
12488
12797
|
|
|
@@ -12499,7 +12808,7 @@ lib/command/interfaces/ISchema.md
|
|
|
12499
12808
|
|
|
12500
12809
|
# Interface: ISchema
|
|
12501
12810
|
|
|
12502
|
-
Defined in: [lib/command.ts:
|
|
12811
|
+
Defined in: [lib/command/types.ts:9](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L9)
|
|
12503
12812
|
|
|
12504
12813
|
JSON Schema 2020-12 的命令校验子集;不支持的关键字在注册时拒绝
|
|
12505
12814
|
|
|
@@ -12509,7 +12818,7 @@ JSON Schema 2020-12 的命令校验子集;不支持的关键字在注册时拒
|
|
|
12509
12818
|
|
|
12510
12819
|
> `optional` **$defs?**: `Record`\<`string`, `boolean` \| `ISchema`\>
|
|
12511
12820
|
|
|
12512
|
-
Defined in: [lib/command.ts:
|
|
12821
|
+
Defined in: [lib/command/types.ts:12](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L12)
|
|
12513
12822
|
|
|
12514
12823
|
***
|
|
12515
12824
|
|
|
@@ -12517,7 +12826,7 @@ Defined in: [lib/command.ts:18](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12517
12826
|
|
|
12518
12827
|
> `optional` **$ref?**: `string`
|
|
12519
12828
|
|
|
12520
|
-
Defined in: [lib/command.ts:
|
|
12829
|
+
Defined in: [lib/command/types.ts:11](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L11)
|
|
12521
12830
|
|
|
12522
12831
|
***
|
|
12523
12832
|
|
|
@@ -12525,7 +12834,7 @@ Defined in: [lib/command.ts:17](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12525
12834
|
|
|
12526
12835
|
> `optional` **$schema?**: `string`
|
|
12527
12836
|
|
|
12528
|
-
Defined in: [lib/command.ts:
|
|
12837
|
+
Defined in: [lib/command/types.ts:10](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L10)
|
|
12529
12838
|
|
|
12530
12839
|
***
|
|
12531
12840
|
|
|
@@ -12533,7 +12842,7 @@ Defined in: [lib/command.ts:16](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12533
12842
|
|
|
12534
12843
|
> `optional` **additionalProperties?**: `boolean` \| `ISchema`
|
|
12535
12844
|
|
|
12536
|
-
Defined in: [lib/command.ts:
|
|
12845
|
+
Defined in: [lib/command/types.ts:20](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L20)
|
|
12537
12846
|
|
|
12538
12847
|
***
|
|
12539
12848
|
|
|
@@ -12541,7 +12850,7 @@ Defined in: [lib/command.ts:26](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12541
12850
|
|
|
12542
12851
|
> `optional` **allOf?**: (`boolean` \| `ISchema`)[]
|
|
12543
12852
|
|
|
12544
|
-
Defined in: [lib/command.ts:
|
|
12853
|
+
Defined in: [lib/command/types.ts:34](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L34)
|
|
12545
12854
|
|
|
12546
12855
|
***
|
|
12547
12856
|
|
|
@@ -12549,7 +12858,7 @@ Defined in: [lib/command.ts:40](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12549
12858
|
|
|
12550
12859
|
> `optional` **anyOf?**: (`boolean` \| `ISchema`)[]
|
|
12551
12860
|
|
|
12552
|
-
Defined in: [lib/command.ts:
|
|
12861
|
+
Defined in: [lib/command/types.ts:35](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L35)
|
|
12553
12862
|
|
|
12554
12863
|
***
|
|
12555
12864
|
|
|
@@ -12557,7 +12866,7 @@ Defined in: [lib/command.ts:41](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12557
12866
|
|
|
12558
12867
|
> `optional` **const?**: [`TJson`](../../tool/type-aliases/TJson.md)
|
|
12559
12868
|
|
|
12560
|
-
Defined in: [lib/command.ts:
|
|
12869
|
+
Defined in: [lib/command/types.ts:33](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L33)
|
|
12561
12870
|
|
|
12562
12871
|
***
|
|
12563
12872
|
|
|
@@ -12565,7 +12874,7 @@ Defined in: [lib/command.ts:39](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12565
12874
|
|
|
12566
12875
|
> `optional` **default?**: [`TJson`](../../tool/type-aliases/TJson.md)
|
|
12567
12876
|
|
|
12568
|
-
Defined in: [lib/command.ts:
|
|
12877
|
+
Defined in: [lib/command/types.ts:15](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L15)
|
|
12569
12878
|
|
|
12570
12879
|
***
|
|
12571
12880
|
|
|
@@ -12573,7 +12882,7 @@ Defined in: [lib/command.ts:21](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12573
12882
|
|
|
12574
12883
|
> `optional` **description?**: `string`
|
|
12575
12884
|
|
|
12576
|
-
Defined in: [lib/command.ts:
|
|
12885
|
+
Defined in: [lib/command/types.ts:14](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L14)
|
|
12577
12886
|
|
|
12578
12887
|
***
|
|
12579
12888
|
|
|
@@ -12581,7 +12890,7 @@ Defined in: [lib/command.ts:20](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12581
12890
|
|
|
12582
12891
|
> `optional` **enum?**: [`TJson`](../../tool/type-aliases/TJson.md)[]
|
|
12583
12892
|
|
|
12584
|
-
Defined in: [lib/command.ts:
|
|
12893
|
+
Defined in: [lib/command/types.ts:32](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L32)
|
|
12585
12894
|
|
|
12586
12895
|
***
|
|
12587
12896
|
|
|
@@ -12589,7 +12898,7 @@ Defined in: [lib/command.ts:38](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12589
12898
|
|
|
12590
12899
|
> `optional` **examples?**: [`TJson`](../../tool/type-aliases/TJson.md)[]
|
|
12591
12900
|
|
|
12592
|
-
Defined in: [lib/command.ts:
|
|
12901
|
+
Defined in: [lib/command/types.ts:16](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L16)
|
|
12593
12902
|
|
|
12594
12903
|
***
|
|
12595
12904
|
|
|
@@ -12597,7 +12906,7 @@ Defined in: [lib/command.ts:22](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12597
12906
|
|
|
12598
12907
|
> `optional` **exclusiveMaximum?**: `number`
|
|
12599
12908
|
|
|
12600
|
-
Defined in: [lib/command.ts:
|
|
12909
|
+
Defined in: [lib/command/types.ts:31](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L31)
|
|
12601
12910
|
|
|
12602
12911
|
***
|
|
12603
12912
|
|
|
@@ -12605,7 +12914,7 @@ Defined in: [lib/command.ts:37](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12605
12914
|
|
|
12606
12915
|
> `optional` **exclusiveMinimum?**: `number`
|
|
12607
12916
|
|
|
12608
|
-
Defined in: [lib/command.ts:
|
|
12917
|
+
Defined in: [lib/command/types.ts:30](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L30)
|
|
12609
12918
|
|
|
12610
12919
|
***
|
|
12611
12920
|
|
|
@@ -12613,7 +12922,7 @@ Defined in: [lib/command.ts:36](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12613
12922
|
|
|
12614
12923
|
> `optional` **items?**: `boolean` \| `ISchema`
|
|
12615
12924
|
|
|
12616
|
-
Defined in: [lib/command.ts:
|
|
12925
|
+
Defined in: [lib/command/types.ts:21](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L21)
|
|
12617
12926
|
|
|
12618
12927
|
***
|
|
12619
12928
|
|
|
@@ -12621,7 +12930,7 @@ Defined in: [lib/command.ts:27](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12621
12930
|
|
|
12622
12931
|
> `optional` **maximum?**: `number`
|
|
12623
12932
|
|
|
12624
|
-
Defined in: [lib/command.ts:
|
|
12933
|
+
Defined in: [lib/command/types.ts:29](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L29)
|
|
12625
12934
|
|
|
12626
12935
|
***
|
|
12627
12936
|
|
|
@@ -12629,7 +12938,7 @@ Defined in: [lib/command.ts:35](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12629
12938
|
|
|
12630
12939
|
> `optional` **maxItems?**: `number`
|
|
12631
12940
|
|
|
12632
|
-
Defined in: [lib/command.ts:
|
|
12941
|
+
Defined in: [lib/command/types.ts:23](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L23)
|
|
12633
12942
|
|
|
12634
12943
|
***
|
|
12635
12944
|
|
|
@@ -12637,7 +12946,7 @@ Defined in: [lib/command.ts:29](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12637
12946
|
|
|
12638
12947
|
> `optional` **maxLength?**: `number`
|
|
12639
12948
|
|
|
12640
|
-
Defined in: [lib/command.ts:
|
|
12949
|
+
Defined in: [lib/command/types.ts:26](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L26)
|
|
12641
12950
|
|
|
12642
12951
|
***
|
|
12643
12952
|
|
|
@@ -12645,7 +12954,7 @@ Defined in: [lib/command.ts:32](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12645
12954
|
|
|
12646
12955
|
> `optional` **minimum?**: `number`
|
|
12647
12956
|
|
|
12648
|
-
Defined in: [lib/command.ts:
|
|
12957
|
+
Defined in: [lib/command/types.ts:28](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L28)
|
|
12649
12958
|
|
|
12650
12959
|
***
|
|
12651
12960
|
|
|
@@ -12653,7 +12962,7 @@ Defined in: [lib/command.ts:34](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12653
12962
|
|
|
12654
12963
|
> `optional` **minItems?**: `number`
|
|
12655
12964
|
|
|
12656
|
-
Defined in: [lib/command.ts:
|
|
12965
|
+
Defined in: [lib/command/types.ts:22](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L22)
|
|
12657
12966
|
|
|
12658
12967
|
***
|
|
12659
12968
|
|
|
@@ -12661,7 +12970,7 @@ Defined in: [lib/command.ts:28](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12661
12970
|
|
|
12662
12971
|
> `optional` **minLength?**: `number`
|
|
12663
12972
|
|
|
12664
|
-
Defined in: [lib/command.ts:
|
|
12973
|
+
Defined in: [lib/command/types.ts:25](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L25)
|
|
12665
12974
|
|
|
12666
12975
|
***
|
|
12667
12976
|
|
|
@@ -12669,7 +12978,7 @@ Defined in: [lib/command.ts:31](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12669
12978
|
|
|
12670
12979
|
> `optional` **not?**: `boolean` \| `ISchema`
|
|
12671
12980
|
|
|
12672
|
-
Defined in: [lib/command.ts:
|
|
12981
|
+
Defined in: [lib/command/types.ts:37](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L37)
|
|
12673
12982
|
|
|
12674
12983
|
***
|
|
12675
12984
|
|
|
@@ -12677,7 +12986,7 @@ Defined in: [lib/command.ts:43](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12677
12986
|
|
|
12678
12987
|
> `optional` **oneOf?**: (`boolean` \| `ISchema`)[]
|
|
12679
12988
|
|
|
12680
|
-
Defined in: [lib/command.ts:
|
|
12989
|
+
Defined in: [lib/command/types.ts:36](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L36)
|
|
12681
12990
|
|
|
12682
12991
|
***
|
|
12683
12992
|
|
|
@@ -12685,7 +12994,7 @@ Defined in: [lib/command.ts:42](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12685
12994
|
|
|
12686
12995
|
> `optional` **pattern?**: `string`
|
|
12687
12996
|
|
|
12688
|
-
Defined in: [lib/command.ts:
|
|
12997
|
+
Defined in: [lib/command/types.ts:27](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L27)
|
|
12689
12998
|
|
|
12690
12999
|
***
|
|
12691
13000
|
|
|
@@ -12693,7 +13002,7 @@ Defined in: [lib/command.ts:33](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12693
13002
|
|
|
12694
13003
|
> `optional` **properties?**: `Record`\<`string`, `boolean` \| `ISchema`\>
|
|
12695
13004
|
|
|
12696
|
-
Defined in: [lib/command.ts:
|
|
13005
|
+
Defined in: [lib/command/types.ts:18](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L18)
|
|
12697
13006
|
|
|
12698
13007
|
***
|
|
12699
13008
|
|
|
@@ -12701,7 +13010,7 @@ Defined in: [lib/command.ts:24](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12701
13010
|
|
|
12702
13011
|
> `optional` **required?**: `string`[]
|
|
12703
13012
|
|
|
12704
|
-
Defined in: [lib/command.ts:
|
|
13013
|
+
Defined in: [lib/command/types.ts:19](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L19)
|
|
12705
13014
|
|
|
12706
13015
|
***
|
|
12707
13016
|
|
|
@@ -12709,7 +13018,7 @@ Defined in: [lib/command.ts:25](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12709
13018
|
|
|
12710
13019
|
> `optional` **title?**: `string`
|
|
12711
13020
|
|
|
12712
|
-
Defined in: [lib/command.ts:
|
|
13021
|
+
Defined in: [lib/command/types.ts:13](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L13)
|
|
12713
13022
|
|
|
12714
13023
|
***
|
|
12715
13024
|
|
|
@@ -12717,7 +13026,7 @@ Defined in: [lib/command.ts:19](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12717
13026
|
|
|
12718
13027
|
> `optional` **type?**: `"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"array"` \| `"integer"` \| `"null"`
|
|
12719
13028
|
|
|
12720
|
-
Defined in: [lib/command.ts:
|
|
13029
|
+
Defined in: [lib/command/types.ts:17](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L17)
|
|
12721
13030
|
|
|
12722
13031
|
***
|
|
12723
13032
|
|
|
@@ -12725,7 +13034,7 @@ Defined in: [lib/command.ts:23](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
12725
13034
|
|
|
12726
13035
|
> `optional` **uniqueItems?**: `boolean`
|
|
12727
13036
|
|
|
12728
|
-
Defined in: [lib/command.ts:
|
|
13037
|
+
Defined in: [lib/command/types.ts:24](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L24)
|
|
12729
13038
|
|
|
12730
13039
|
lib/command/type-aliases/TJson.md
|
|
12731
13040
|
---
|
|
@@ -12740,7 +13049,7 @@ lib/command/type-aliases/TJson.md
|
|
|
12740
13049
|
|
|
12741
13050
|
> **TJson** = [`TJson`](../../tool/type-aliases/TJson.md)
|
|
12742
13051
|
|
|
12743
|
-
Defined in: [lib/command.ts:
|
|
13052
|
+
Defined in: [lib/command/types.ts:6](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L6)
|
|
12744
13053
|
|
|
12745
13054
|
命令输入与输出可跨浏览器、Native 和协议传输的 JSON 值
|
|
12746
13055
|
|
|
@@ -12755,9 +13064,9 @@ lib/command/type-aliases/TResult.md
|
|
|
12755
13064
|
|
|
12756
13065
|
# Type Alias: TResult\<T\>
|
|
12757
13066
|
|
|
12758
|
-
> **TResult**\<`T`\> = \{ `data`: `T`; `ok`: `true`; \} \| \{ `error`: \{ `code`: `string`; `message`: `string`; \}; `ok`: `false`; \}
|
|
13067
|
+
> **TResult**\<`T`\> = \{ `data`: `T`; `files?`: [`IFileInfo`](../interfaces/IFileInfo.md)[]; `ok`: `true`; \} \| \{ `error`: \{ `code`: `string`; `message`: `string`; \}; `ok`: `false`; \}
|
|
12759
13068
|
|
|
12760
|
-
Defined in: [lib/command.ts:
|
|
13069
|
+
Defined in: [lib/command/types.ts:41](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L41)
|
|
12761
13070
|
|
|
12762
13071
|
所有入口共用的结果;错误码用于程序判断,message 用于说明
|
|
12763
13072
|
|
|
@@ -12780,7 +13089,7 @@ lib/command/type-aliases/TWebMcpRegistrationStatus.md
|
|
|
12780
13089
|
|
|
12781
13090
|
> **TWebMcpRegistrationStatus** = `"idle"` \| `"registering"` \| `"ready"` \| `"failed"`
|
|
12782
13091
|
|
|
12783
|
-
Defined in: [lib/command.ts:
|
|
13092
|
+
Defined in: [lib/command/types.ts:131](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L131)
|
|
12784
13093
|
|
|
12785
13094
|
工具发布诊断状态,不参与页面级接入事件
|
|
12786
13095
|
|
|
@@ -12797,7 +13106,7 @@ lib/command/type-aliases/TWebMcpStatus.md
|
|
|
12797
13106
|
|
|
12798
13107
|
> **TWebMcpStatus** = `"unsupported"` \| `"ready"`
|
|
12799
13108
|
|
|
12800
|
-
Defined in: [lib/command.ts:
|
|
13109
|
+
Defined in: [lib/command/types.ts:128](https://github.com/maiyun/clickgo/blob/master/dist/lib/command/types.ts#L128)
|
|
12801
13110
|
|
|
12802
13111
|
页面级 WebMCP 接入状态;ready 表示浏览器接口可用,不表示某个 App 的工具已发布
|
|
12803
13112
|
|
|
@@ -31430,7 +31739,7 @@ lib/native/functions/activate.md
|
|
|
31430
31739
|
|
|
31431
31740
|
> **activate**(`current`): `Promise`\<`boolean`\>
|
|
31432
31741
|
|
|
31433
|
-
Defined in: [lib/native.ts:
|
|
31742
|
+
Defined in: [lib/native.ts:445](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L445)
|
|
31434
31743
|
|
|
31435
31744
|
## Parameters
|
|
31436
31745
|
|
|
@@ -31486,7 +31795,7 @@ lib/native/functions/clear.md
|
|
|
31486
31795
|
|
|
31487
31796
|
> **clear**(`taskId`, `formId?`): `void`
|
|
31488
31797
|
|
|
31489
|
-
Defined in: [lib/native.ts:
|
|
31798
|
+
Defined in: [lib/native.ts:288](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L288)
|
|
31490
31799
|
|
|
31491
31800
|
清除某个窗体或某个任务的所有事件监听
|
|
31492
31801
|
|
|
@@ -31521,7 +31830,7 @@ lib/native/functions/close.md
|
|
|
31521
31830
|
|
|
31522
31831
|
> **close**(`current`): `Promise`\<`boolean`\>
|
|
31523
31832
|
|
|
31524
|
-
Defined in: [lib/native.ts:
|
|
31833
|
+
Defined in: [lib/native.ts:457](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L457)
|
|
31525
31834
|
|
|
31526
31835
|
关闭当前 native 真实窗体,根据配置整个 native 任务可能结束也可能保留 node 不结束
|
|
31527
31836
|
|
|
@@ -31550,7 +31859,7 @@ lib/native/functions/dialog.md
|
|
|
31550
31859
|
|
|
31551
31860
|
> **dialog**(`options?`): `Promise`\<`number`\>
|
|
31552
31861
|
|
|
31553
|
-
Defined in: [lib/native.ts:
|
|
31862
|
+
Defined in: [lib/native.ts:524](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L524)
|
|
31554
31863
|
|
|
31555
31864
|
弹出消息框
|
|
31556
31865
|
|
|
@@ -31612,7 +31921,7 @@ lib/native/functions/getCommandEntry.md
|
|
|
31612
31921
|
|
|
31613
31922
|
> **getCommandEntry**(): `Promise`\<[`ICommandEntry`](../interfaces/ICommandEntry.md) \| `null`\>
|
|
31614
31923
|
|
|
31615
|
-
Defined in: [lib/native.ts:
|
|
31924
|
+
Defined in: [lib/native.ts:161](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L161)
|
|
31616
31925
|
|
|
31617
31926
|
取得软件自身的 CLI/stdio 入口和启动要求,无需读取连接凭据
|
|
31618
31927
|
|
|
@@ -31635,7 +31944,7 @@ lib/native/functions/getListenerList.md
|
|
|
31635
31944
|
|
|
31636
31945
|
> **getListenerList**(`taskId?`): `Record`\<`string`, `Record`\<`string`, `Record`\<`string`, `number`\>\>\>
|
|
31637
31946
|
|
|
31638
|
-
Defined in: [lib/native.ts:
|
|
31947
|
+
Defined in: [lib/native.ts:311](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L311)
|
|
31639
31948
|
|
|
31640
31949
|
获取监听 native 事件的监听统计信息列表
|
|
31641
31950
|
|
|
@@ -31664,7 +31973,7 @@ lib/native/functions/getMcpInfo.md
|
|
|
31664
31973
|
|
|
31665
31974
|
> **getMcpInfo**(`current`): `Promise`\<`false` \| [`IMcpInfo`](../interfaces/IMcpInfo.md) \| `null`\>
|
|
31666
31975
|
|
|
31667
|
-
Defined in: [lib/native.ts:
|
|
31976
|
+
Defined in: [lib/native.ts:170](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L170)
|
|
31668
31977
|
|
|
31669
31978
|
读取 Native 主进程启用的 MCP 连接设置
|
|
31670
31979
|
|
|
@@ -31726,7 +32035,7 @@ lib/native/functions/init.md
|
|
|
31726
32035
|
|
|
31727
32036
|
> **init**(): `void`
|
|
31728
32037
|
|
|
31729
|
-
Defined in: [lib/native.ts:
|
|
32038
|
+
Defined in: [lib/native.ts:555](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L555)
|
|
31730
32039
|
|
|
31731
32040
|
## Returns
|
|
31732
32041
|
|
|
@@ -31805,7 +32114,7 @@ lib/native/functions/invoke.md
|
|
|
31805
32114
|
|
|
31806
32115
|
> **invoke**(`name`, ...`param`): `Promise`\<`any`\>
|
|
31807
32116
|
|
|
31808
|
-
Defined in: [lib/native.ts:
|
|
32117
|
+
Defined in: [lib/native.ts:352](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L352)
|
|
31809
32118
|
|
|
31810
32119
|
向 native 发送指令
|
|
31811
32120
|
|
|
@@ -31840,7 +32149,7 @@ lib/native/functions/invokeSys.md
|
|
|
31840
32149
|
|
|
31841
32150
|
> **invokeSys**(`current`, `name`, ...`param`): `Promise`\<`any`\>
|
|
31842
32151
|
|
|
31843
|
-
Defined in: [lib/native.ts:
|
|
32152
|
+
Defined in: [lib/native.ts:365](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L365)
|
|
31844
32153
|
|
|
31845
32154
|
向 native 发送指令(系统级)
|
|
31846
32155
|
|
|
@@ -31918,7 +32227,7 @@ lib/native/functions/isMax.md
|
|
|
31918
32227
|
|
|
31919
32228
|
> **isMax**(): `Promise`\<`boolean`\>
|
|
31920
32229
|
|
|
31921
|
-
Defined in: [lib/native.ts:
|
|
32230
|
+
Defined in: [lib/native.ts:548](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L548)
|
|
31922
32231
|
|
|
31923
32232
|
判断窗体是否是最大化状态
|
|
31924
32233
|
|
|
@@ -31939,7 +32248,7 @@ lib/native/functions/maximizable.md
|
|
|
31939
32248
|
|
|
31940
32249
|
> **maximizable**(`current`, `val`): `Promise`\<`boolean`\>
|
|
31941
32250
|
|
|
31942
|
-
Defined in: [lib/native.ts:
|
|
32251
|
+
Defined in: [lib/native.ts:465](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L465)
|
|
31943
32252
|
|
|
31944
32253
|
## Parameters
|
|
31945
32254
|
|
|
@@ -31968,7 +32277,7 @@ lib/native/functions/max.md
|
|
|
31968
32277
|
|
|
31969
32278
|
> **max**(`current`): `Promise`\<`boolean`\>
|
|
31970
32279
|
|
|
31971
|
-
Defined in: [lib/native.ts:
|
|
32280
|
+
Defined in: [lib/native.ts:411](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L411)
|
|
31972
32281
|
|
|
31973
32282
|
## Parameters
|
|
31974
32283
|
|
|
@@ -31993,7 +32302,7 @@ lib/native/functions/min.md
|
|
|
31993
32302
|
|
|
31994
32303
|
> **min**(`current`): `Promise`\<`boolean`\>
|
|
31995
32304
|
|
|
31996
|
-
Defined in: [lib/native.ts:
|
|
32305
|
+
Defined in: [lib/native.ts:419](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L419)
|
|
31997
32306
|
|
|
31998
32307
|
## Parameters
|
|
31999
32308
|
|
|
@@ -32018,7 +32327,7 @@ lib/native/functions/minSize.md
|
|
|
32018
32327
|
|
|
32019
32328
|
> **minSize**(`current`, `width`, `height`): `Promise`\<`boolean`\>
|
|
32020
32329
|
|
|
32021
|
-
Defined in: [lib/native.ts:
|
|
32330
|
+
Defined in: [lib/native.ts:400](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L400)
|
|
32022
32331
|
|
|
32023
32332
|
设置实体窗体的最小尺寸,0 表示不限制对应方向
|
|
32024
32333
|
|
|
@@ -32059,7 +32368,7 @@ lib/native/functions/off.md
|
|
|
32059
32368
|
|
|
32060
32369
|
> **off**(`current`, `name`, `formId?`): `void`
|
|
32061
32370
|
|
|
32062
|
-
Defined in: [lib/native.ts:
|
|
32371
|
+
Defined in: [lib/native.ts:269](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L269)
|
|
32063
32372
|
|
|
32064
32373
|
解绑监听的方法
|
|
32065
32374
|
|
|
@@ -32100,7 +32409,7 @@ lib/native/functions/once.md
|
|
|
32100
32409
|
|
|
32101
32410
|
> **once**(`current`, `name`, `handler`, `formId?`): `void`
|
|
32102
32411
|
|
|
32103
|
-
Defined in: [lib/native.ts:
|
|
32412
|
+
Defined in: [lib/native.ts:254](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L254)
|
|
32104
32413
|
|
|
32105
32414
|
监听 native 传输过来的事件(仅一次)
|
|
32106
32415
|
|
|
@@ -32147,7 +32456,7 @@ lib/native/functions/on.md
|
|
|
32147
32456
|
|
|
32148
32457
|
> **on**(`current`, `name`, `handler`, `once?`, `formId?`): `void`
|
|
32149
32458
|
|
|
32150
|
-
Defined in: [lib/native.ts:
|
|
32459
|
+
Defined in: [lib/native.ts:225](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L225)
|
|
32151
32460
|
|
|
32152
32461
|
监听 native 传输过来的事件
|
|
32153
32462
|
|
|
@@ -32237,7 +32546,7 @@ lib/native/functions/open.md
|
|
|
32237
32546
|
|
|
32238
32547
|
> **open**(`options?`): `Promise`\<`string`[] \| `null`\>
|
|
32239
32548
|
|
|
32240
|
-
Defined in: [lib/native.ts:
|
|
32549
|
+
Defined in: [lib/native.ts:480](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L480)
|
|
32241
32550
|
|
|
32242
32551
|
弹出文件选择框
|
|
32243
32552
|
|
|
@@ -32300,7 +32609,7 @@ lib/native/functions/ping.md
|
|
|
32300
32609
|
|
|
32301
32610
|
> **ping**(`val`): `Promise`\<`string`\>
|
|
32302
32611
|
|
|
32303
|
-
Defined in: [lib/native.ts:
|
|
32612
|
+
Defined in: [lib/native.ts:541](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L541)
|
|
32304
32613
|
|
|
32305
32614
|
测试与 native 的连通性
|
|
32306
32615
|
|
|
@@ -32331,7 +32640,7 @@ lib/native/functions/quit.md
|
|
|
32331
32640
|
|
|
32332
32641
|
> **quit**(`current`): `Promise`\<`boolean`\>
|
|
32333
32642
|
|
|
32334
|
-
Defined in: [lib/native.ts:
|
|
32643
|
+
Defined in: [lib/native.ts:378](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L378)
|
|
32335
32644
|
|
|
32336
32645
|
直接让整个 native 进程退出
|
|
32337
32646
|
|
|
@@ -32391,7 +32700,7 @@ lib/native/functions/restore.md
|
|
|
32391
32700
|
|
|
32392
32701
|
> **restore**(`current`): `Promise`\<`boolean`\>
|
|
32393
32702
|
|
|
32394
|
-
Defined in: [lib/native.ts:
|
|
32703
|
+
Defined in: [lib/native.ts:437](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L437)
|
|
32395
32704
|
|
|
32396
32705
|
从最小化还原
|
|
32397
32706
|
|
|
@@ -32418,7 +32727,7 @@ lib/native/functions/save.md
|
|
|
32418
32727
|
|
|
32419
32728
|
> **save**(`options?`): `Promise`\<`string` \| `null`\>
|
|
32420
32729
|
|
|
32421
|
-
Defined in: [lib/native.ts:
|
|
32730
|
+
Defined in: [lib/native.ts:506](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L506)
|
|
32422
32731
|
|
|
32423
32732
|
弹出文件保存框
|
|
32424
32733
|
|
|
@@ -32459,7 +32768,7 @@ lib/native/functions/size.md
|
|
|
32459
32768
|
|
|
32460
32769
|
> **size**(`current`, `width`, `height`): `Promise`\<`boolean`\>
|
|
32461
32770
|
|
|
32462
|
-
Defined in: [lib/native.ts:
|
|
32771
|
+
Defined in: [lib/native.ts:386](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L386)
|
|
32463
32772
|
|
|
32464
32773
|
## Parameters
|
|
32465
32774
|
|
|
@@ -32492,7 +32801,7 @@ lib/native/functions/unmaximize.md
|
|
|
32492
32801
|
|
|
32493
32802
|
> **unmaximize**(`current`): `Promise`\<`boolean`\>
|
|
32494
32803
|
|
|
32495
|
-
Defined in: [lib/native.ts:
|
|
32804
|
+
Defined in: [lib/native.ts:428](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L428)
|
|
32496
32805
|
|
|
32497
32806
|
从最大化还原
|
|
32498
32807
|
|
|
@@ -32582,7 +32891,7 @@ lib/native/interfaces/ICommandEntry.md
|
|
|
32582
32891
|
|
|
32583
32892
|
# Interface: ICommandEntry
|
|
32584
32893
|
|
|
32585
|
-
Defined in: [lib/native.ts:
|
|
32894
|
+
Defined in: [lib/native.ts:148](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L148)
|
|
32586
32895
|
|
|
32587
32896
|
当前 Native 的公开进程入口,不包含 HTTP 连接凭据
|
|
32588
32897
|
|
|
@@ -32592,7 +32901,7 @@ Defined in: [lib/native.ts:146](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32592
32901
|
|
|
32593
32902
|
> **args**: `string`[]
|
|
32594
32903
|
|
|
32595
|
-
Defined in: [lib/native.ts:
|
|
32904
|
+
Defined in: [lib/native.ts:152](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L152)
|
|
32596
32905
|
|
|
32597
32906
|
***
|
|
32598
32907
|
|
|
@@ -32600,7 +32909,7 @@ Defined in: [lib/native.ts:150](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32600
32909
|
|
|
32601
32910
|
> **command**: `string`
|
|
32602
32911
|
|
|
32603
|
-
Defined in: [lib/native.ts:
|
|
32912
|
+
Defined in: [lib/native.ts:151](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L151)
|
|
32604
32913
|
|
|
32605
32914
|
***
|
|
32606
32915
|
|
|
@@ -32608,7 +32917,7 @@ Defined in: [lib/native.ts:149](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32608
32917
|
|
|
32609
32918
|
> **mcp**: `object`
|
|
32610
32919
|
|
|
32611
|
-
Defined in: [lib/native.ts:
|
|
32920
|
+
Defined in: [lib/native.ts:154](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L154)
|
|
32612
32921
|
|
|
32613
32922
|
#### discovery
|
|
32614
32923
|
|
|
@@ -32624,7 +32933,7 @@ Defined in: [lib/native.ts:152](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32624
32933
|
|
|
32625
32934
|
> **name**: `string`
|
|
32626
32935
|
|
|
32627
|
-
Defined in: [lib/native.ts:
|
|
32936
|
+
Defined in: [lib/native.ts:149](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L149)
|
|
32628
32937
|
|
|
32629
32938
|
***
|
|
32630
32939
|
|
|
@@ -32632,7 +32941,7 @@ Defined in: [lib/native.ts:147](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32632
32941
|
|
|
32633
32942
|
> **platform**: `string`
|
|
32634
32943
|
|
|
32635
|
-
Defined in: [lib/native.ts:
|
|
32944
|
+
Defined in: [lib/native.ts:150](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L150)
|
|
32636
32945
|
|
|
32637
32946
|
***
|
|
32638
32947
|
|
|
@@ -32640,7 +32949,7 @@ Defined in: [lib/native.ts:148](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32640
32949
|
|
|
32641
32950
|
> **startup**: `"auto"` \| `"existing"`
|
|
32642
32951
|
|
|
32643
|
-
Defined in: [lib/native.ts:
|
|
32952
|
+
Defined in: [lib/native.ts:153](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L153)
|
|
32644
32953
|
|
|
32645
32954
|
lib/native/interfaces/IMcpInfo.md
|
|
32646
32955
|
---
|
|
@@ -32653,7 +32962,7 @@ lib/native/interfaces/IMcpInfo.md
|
|
|
32653
32962
|
|
|
32654
32963
|
# Interface: IMcpInfo
|
|
32655
32964
|
|
|
32656
|
-
Defined in: [lib/native.ts:
|
|
32965
|
+
Defined in: [lib/native.ts:141](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L141)
|
|
32657
32966
|
|
|
32658
32967
|
本地 MCP 客户端连接设置;仅向已授权 root 的 App 提供
|
|
32659
32968
|
|
|
@@ -32663,7 +32972,7 @@ Defined in: [lib/native.ts:139](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32663
32972
|
|
|
32664
32973
|
> **token**: `string`
|
|
32665
32974
|
|
|
32666
|
-
Defined in: [lib/native.ts:
|
|
32975
|
+
Defined in: [lib/native.ts:144](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L144)
|
|
32667
32976
|
|
|
32668
32977
|
***
|
|
32669
32978
|
|
|
@@ -32671,7 +32980,7 @@ Defined in: [lib/native.ts:142](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32671
32980
|
|
|
32672
32981
|
> **transport**: `"streamable-http"`
|
|
32673
32982
|
|
|
32674
|
-
Defined in: [lib/native.ts:
|
|
32983
|
+
Defined in: [lib/native.ts:142](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L142)
|
|
32675
32984
|
|
|
32676
32985
|
***
|
|
32677
32986
|
|
|
@@ -32679,7 +32988,7 @@ Defined in: [lib/native.ts:140](https://github.com/maiyun/clickgo/blob/master/di
|
|
|
32679
32988
|
|
|
32680
32989
|
> **url**: `string`
|
|
32681
32990
|
|
|
32682
|
-
Defined in: [lib/native.ts:
|
|
32991
|
+
Defined in: [lib/native.ts:143](https://github.com/maiyun/clickgo/blob/master/dist/lib/native.ts#L143)
|
|
32683
32992
|
|
|
32684
32993
|
lib/native/interfaces/INativeLaunchEvent.md
|
|
32685
32994
|
---
|