tccli 3.0.1324.1__py2.py3-none-any.whl → 3.0.1326.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +1 -1
- tccli/services/cfs/v20190719/api.json +59 -59
- tccli/services/cfs/v20190719/examples.json +3 -3
- tccli/services/cme/v20191029/api.json +16 -19
- tccli/services/cme/v20191029/examples.json +12 -12
- tccli/services/cynosdb/v20190107/api.json +7 -7
- tccli/services/dlc/dlc_client.py +53 -0
- tccli/services/dlc/v20210125/api.json +51 -0
- tccli/services/dlc/v20210125/examples.json +8 -0
- tccli/services/domain/v20180808/api.json +1 -1
- tccli/services/emr/v20190103/api.json +10 -0
- tccli/services/es/es_client.py +4 -57
- tccli/services/es/v20250101/api.json +0 -207
- tccli/services/es/v20250101/examples.json +0 -8
- tccli/services/ess/v20201111/api.json +5 -5
- tccli/services/essbasic/v20210526/api.json +3 -3
- tccli/services/gs/gs_client.py +106 -0
- tccli/services/gs/v20191118/api.json +145 -0
- tccli/services/gs/v20191118/examples.json +16 -0
- tccli/services/hai/v20230812/api.json +5 -5
- tccli/services/iotexplorer/v20190423/api.json +1 -1
- tccli/services/lke/lke_client.py +0 -53
- tccli/services/lke/v20231130/api.json +0 -113
- tccli/services/lke/v20231130/examples.json +0 -8
- tccli/services/lkeap/v20240522/api.json +1 -1
- tccli/services/monitor/monitor_client.py +53 -0
- tccli/services/monitor/v20180724/api.json +54 -1
- tccli/services/monitor/v20180724/examples.json +8 -0
- tccli/services/mqtt/mqtt_client.py +57 -4
- tccli/services/mqtt/v20240516/api.json +260 -124
- tccli/services/mqtt/v20240516/examples.json +9 -1
- tccli/services/mrs/v20200910/api.json +4 -4
- tccli/services/postgres/postgres_client.py +0 -53
- tccli/services/postgres/v20170312/api.json +0 -235
- tccli/services/postgres/v20170312/examples.json +0 -8
- tccli/services/privatedns/v20201028/api.json +1 -1
- tccli/services/pts/v20210728/api.json +18 -0
- tccli/services/redis/v20180412/api.json +1 -1
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1326.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1326.1.dist-info}/RECORD +44 -44
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1326.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1326.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1326.1.dist-info}/license_files/LICENSE +0 -0
@@ -62,13 +62,6 @@
|
|
62
62
|
"name": "重排序",
|
63
63
|
"output": "RunRerankResponse",
|
64
64
|
"status": "online"
|
65
|
-
},
|
66
|
-
"WebSearch": {
|
67
|
-
"document": "WebSearch API 是一个网页搜索服务,支持多种搜索引擎,可以获取网页的标题、URL、摘要和正文内容。",
|
68
|
-
"input": "WebSearchRequest",
|
69
|
-
"name": "网页搜索",
|
70
|
-
"output": "WebSearchResponse",
|
71
|
-
"status": "online"
|
72
65
|
}
|
73
66
|
},
|
74
67
|
"metadata": {
|
@@ -1185,206 +1178,6 @@
|
|
1185
1178
|
}
|
1186
1179
|
],
|
1187
1180
|
"usage": "out"
|
1188
|
-
},
|
1189
|
-
"WebPage": {
|
1190
|
-
"document": "网页搜索结果",
|
1191
|
-
"members": [
|
1192
|
-
{
|
1193
|
-
"disabled": false,
|
1194
|
-
"document": "标题",
|
1195
|
-
"example": "2025年政府财政改革报告",
|
1196
|
-
"member": "string",
|
1197
|
-
"name": "Title",
|
1198
|
-
"output_required": true,
|
1199
|
-
"required": false,
|
1200
|
-
"type": "string",
|
1201
|
-
"value_allowed_null": false
|
1202
|
-
},
|
1203
|
-
{
|
1204
|
-
"disabled": false,
|
1205
|
-
"document": "url",
|
1206
|
-
"example": "www.example.com",
|
1207
|
-
"member": "string",
|
1208
|
-
"name": "Url",
|
1209
|
-
"output_required": true,
|
1210
|
-
"required": false,
|
1211
|
-
"type": "string",
|
1212
|
-
"value_allowed_null": false
|
1213
|
-
},
|
1214
|
-
{
|
1215
|
-
"disabled": false,
|
1216
|
-
"document": "网页摘要\n注意:此字段可能返回 null,表示取不到有效值。",
|
1217
|
-
"example": "2025年财政改革措施为...",
|
1218
|
-
"member": "string",
|
1219
|
-
"name": "Summary",
|
1220
|
-
"output_required": false,
|
1221
|
-
"required": false,
|
1222
|
-
"type": "string",
|
1223
|
-
"value_allowed_null": true
|
1224
|
-
},
|
1225
|
-
{
|
1226
|
-
"disabled": false,
|
1227
|
-
"document": "网页收录时间。可能为空。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1228
|
-
"example": "2025年4月9日",
|
1229
|
-
"member": "string",
|
1230
|
-
"name": "Time",
|
1231
|
-
"output_required": false,
|
1232
|
-
"required": false,
|
1233
|
-
"type": "string",
|
1234
|
-
"value_allowed_null": true
|
1235
|
-
},
|
1236
|
-
{
|
1237
|
-
"disabled": false,
|
1238
|
-
"document": "Markdown 格式的网页正文\n注意:此字段可能返回 null,表示取不到有效值。",
|
1239
|
-
"example": "2025年财政改革措施为...",
|
1240
|
-
"member": "string",
|
1241
|
-
"name": "Content",
|
1242
|
-
"output_required": false,
|
1243
|
-
"required": false,
|
1244
|
-
"type": "string",
|
1245
|
-
"value_allowed_null": true
|
1246
|
-
}
|
1247
|
-
],
|
1248
|
-
"usage": "both"
|
1249
|
-
},
|
1250
|
-
"WebSearchRequest": {
|
1251
|
-
"document": "WebSearch请求参数结构体",
|
1252
|
-
"members": [
|
1253
|
-
{
|
1254
|
-
"disabled": false,
|
1255
|
-
"document": "查询",
|
1256
|
-
"example": "2025年货币政策有哪些变化?",
|
1257
|
-
"member": "string",
|
1258
|
-
"name": "Query",
|
1259
|
-
"required": true,
|
1260
|
-
"type": "string"
|
1261
|
-
},
|
1262
|
-
{
|
1263
|
-
"disabled": false,
|
1264
|
-
"document": "搜索的网页数量,默认20",
|
1265
|
-
"example": "20",
|
1266
|
-
"member": "uint64",
|
1267
|
-
"name": "Count",
|
1268
|
-
"required": false,
|
1269
|
-
"type": "int"
|
1270
|
-
},
|
1271
|
-
{
|
1272
|
-
"disabled": false,
|
1273
|
-
"document": "指定域名,gov.cn 可匹配 *.gov.cn的域名。",
|
1274
|
-
"example": "gov.cn",
|
1275
|
-
"member": "string",
|
1276
|
-
"name": "Site",
|
1277
|
-
"required": false,
|
1278
|
-
"type": "string"
|
1279
|
-
},
|
1280
|
-
{
|
1281
|
-
"disabled": false,
|
1282
|
-
"document": "是否获取返回网页全文,默认 false。",
|
1283
|
-
"example": "false",
|
1284
|
-
"member": "bool",
|
1285
|
-
"name": "FetchContent",
|
1286
|
-
"required": false,
|
1287
|
-
"type": "bool"
|
1288
|
-
},
|
1289
|
-
{
|
1290
|
-
"disabled": false,
|
1291
|
-
"document": "域名白名单,在不指定 Site 时,只保存匹配白名单域名的网页。",
|
1292
|
-
"example": "[\"zhihu.com\"]",
|
1293
|
-
"member": "string",
|
1294
|
-
"name": "WhiteSites",
|
1295
|
-
"required": false,
|
1296
|
-
"type": "list"
|
1297
|
-
},
|
1298
|
-
{
|
1299
|
-
"disabled": false,
|
1300
|
-
"document": "域名黑名单,在不指定 Site 和白名单时,过滤黑名单中的域名。",
|
1301
|
-
"example": "[\"baidu.com\"]",
|
1302
|
-
"member": "string",
|
1303
|
-
"name": "BlackSites",
|
1304
|
-
"required": false,
|
1305
|
-
"type": "list"
|
1306
|
-
},
|
1307
|
-
{
|
1308
|
-
"disabled": false,
|
1309
|
-
"document": "秒级时间戳,搜索网页的开始时间,默认不限制开始时间。",
|
1310
|
-
"example": "1704038400",
|
1311
|
-
"member": "uint64",
|
1312
|
-
"name": "StartTime",
|
1313
|
-
"required": false,
|
1314
|
-
"type": "int"
|
1315
|
-
},
|
1316
|
-
{
|
1317
|
-
"disabled": false,
|
1318
|
-
"document": "秒级时间戳,搜索网页的结束时间,默认为现在。",
|
1319
|
-
"example": "1712592000",
|
1320
|
-
"member": "uint64",
|
1321
|
-
"name": "EndTime",
|
1322
|
-
"required": false,
|
1323
|
-
"type": "int"
|
1324
|
-
},
|
1325
|
-
{
|
1326
|
-
"disabled": false,
|
1327
|
-
"document": "指定搜索引擎,可选混合搜索 mixed,或 bing, baidu, sogou, 默认为 sogou",
|
1328
|
-
"example": "sogou",
|
1329
|
-
"member": "string",
|
1330
|
-
"name": "SearchEngine",
|
1331
|
-
"required": false,
|
1332
|
-
"type": "string"
|
1333
|
-
}
|
1334
|
-
],
|
1335
|
-
"type": "object"
|
1336
|
-
},
|
1337
|
-
"WebSearchResponse": {
|
1338
|
-
"document": "WebSearch返回参数结构体",
|
1339
|
-
"members": [
|
1340
|
-
{
|
1341
|
-
"disabled": false,
|
1342
|
-
"document": "查询",
|
1343
|
-
"example": "2025年货币政策有哪些变化?",
|
1344
|
-
"member": "string",
|
1345
|
-
"name": "Query",
|
1346
|
-
"output_required": false,
|
1347
|
-
"type": "string",
|
1348
|
-
"value_allowed_null": false
|
1349
|
-
},
|
1350
|
-
{
|
1351
|
-
"disabled": false,
|
1352
|
-
"document": "响应状态",
|
1353
|
-
"example": "completed",
|
1354
|
-
"member": "string",
|
1355
|
-
"name": "Status",
|
1356
|
-
"output_required": false,
|
1357
|
-
"type": "string",
|
1358
|
-
"value_allowed_null": false
|
1359
|
-
},
|
1360
|
-
{
|
1361
|
-
"disabled": false,
|
1362
|
-
"document": "执行搜索的引擎",
|
1363
|
-
"example": "sogou",
|
1364
|
-
"member": "string",
|
1365
|
-
"name": "SearchEngine",
|
1366
|
-
"output_required": false,
|
1367
|
-
"type": "string",
|
1368
|
-
"value_allowed_null": false
|
1369
|
-
},
|
1370
|
-
{
|
1371
|
-
"disabled": false,
|
1372
|
-
"document": "搜索结果",
|
1373
|
-
"example": "无",
|
1374
|
-
"member": "WebPage",
|
1375
|
-
"name": "Results",
|
1376
|
-
"output_required": false,
|
1377
|
-
"type": "list",
|
1378
|
-
"value_allowed_null": false
|
1379
|
-
},
|
1380
|
-
{
|
1381
|
-
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
1382
|
-
"member": "string",
|
1383
|
-
"name": "RequestId",
|
1384
|
-
"type": "string"
|
1385
|
-
}
|
1386
|
-
],
|
1387
|
-
"type": "object"
|
1388
1181
|
}
|
1389
1182
|
},
|
1390
1183
|
"version": "1.0"
|
@@ -71,14 +71,6 @@
|
|
71
71
|
"output": "{\n \"Response\": {\n \"Data\": [\n {\n \"Document\": \"\",\n \"Index\": 1,\n \"RelevanceScore\": 0.9998511075973511\n },\n {\n \"Document\": \"\",\n \"Index\": 0,\n \"RelevanceScore\": 0.9996849298477173\n }\n ],\n \"RequestId\": \"cf9c5598-9625-436d-bc81-8dd3900e63c0\",\n \"Usage\": {\n \"TotalTokens\": 10\n }\n }\n}",
|
72
72
|
"title": "重排序"
|
73
73
|
}
|
74
|
-
],
|
75
|
-
"WebSearch": [
|
76
|
-
{
|
77
|
-
"document": "用户需要搜索 2025 年货币政策相关的网页内容,并指定来源为政府网站。",
|
78
|
-
"input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: WebSearch\n<公共请求参数>\n\n{\n \"Query\": \"2025年货币政策有哪些变化?\",\n \"Count\": 20,\n \"Site\": \"gov.cn\",\n \"FetchContent\": false,\n \"StartTime\": 1704038400,\n \"EndTime\": 1712592000,\n \"SearchEngine\": \"sogou\"\n}",
|
79
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"21739985-c9bf-4add-998b-7c5b055b3289\",\n \"Query\": \"2025年货币政策有哪些变化?\",\n \"Status\": \"completed\",\n \"SearchEngine\": \"sogou\",\n \"Results\": [\n {\n \"Title\": \"2025年政府财政改革报告\",\n \"Url\": \"www.example.gov.cn\",\n \"Summary\": \"2025年财政改革措施为...\",\n \"Time\": \"2025年4月9日\"\n }\n ]\n }\n}",
|
80
|
-
"title": "联网搜索"
|
81
|
-
}
|
82
74
|
]
|
83
75
|
},
|
84
76
|
"version": "1.0"
|
@@ -2009,7 +2009,7 @@
|
|
2009
2009
|
"members": [
|
2010
2010
|
{
|
2011
2011
|
"disabled": false,
|
2012
|
-
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
2012
|
+
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>WATERMARK</b> : 水印控件;只能分配给发起方,必须设置ComponentExtra;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
2013
2013
|
"example": "SIGN_SEAL",
|
2014
2014
|
"member": "string",
|
2015
2015
|
"name": "ComponentType",
|
@@ -2141,7 +2141,7 @@
|
|
2141
2141
|
},
|
2142
2142
|
{
|
2143
2143
|
"disabled": false,
|
2144
|
-
"document": "\n**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
|
2144
|
+
"document": "\n**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
|
2145
2145
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
2146
2146
|
"member": "string",
|
2147
2147
|
"name": "ComponentExtra",
|
@@ -2251,7 +2251,7 @@
|
|
2251
2251
|
},
|
2252
2252
|
{
|
2253
2253
|
"disabled": false,
|
2254
|
-
"document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b>
|
2254
|
+
"document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b> :可以移动和删除控件</li>\n<li> <b>true</b> : 禁止移动和删除控件</li></ul>",
|
2255
2255
|
"example": "false",
|
2256
2256
|
"member": "bool",
|
2257
2257
|
"name": "ForbidMoveAndDelete",
|
@@ -4659,7 +4659,7 @@
|
|
4659
4659
|
},
|
4660
4660
|
{
|
4661
4661
|
"disabled": false,
|
4662
|
-
"document": "在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数
|
4662
|
+
"document": "在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数 只能二选一使用(注: \n<font color='red'>空数组代表未指定</font>),具体的控件类型如下\n\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
|
4663
4663
|
"example": "[\"MULTI_LINE_TEXT\"]",
|
4664
4664
|
"member": "string",
|
4665
4665
|
"name": "HideComponentTypes",
|
@@ -4668,7 +4668,7 @@
|
|
4668
4668
|
},
|
4669
4669
|
{
|
4670
4670
|
"disabled": false,
|
4671
|
-
"document": "在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数
|
4671
|
+
"document": "在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数 只能二选一使用(注: \n<font color='red'>空数组代表未指定</font>),具体的控件类型如下\n<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>\n<li>SIGN_SEAL : 企业印章</li>\n<li>SIGN_PAGING_SEAL : 骑缝章</li>\n<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>\n<li>SIGN_APPROVE : 签批</li>\n<li>SIGN_OPINION : 签署意见</li>\n<li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>\n<li>BUSI-FULL-NAME : 企业全称</li>\n<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>\n<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>\n<li>PERSONAL-NAME : 签署人姓名</li>\n<li>PERSONAL-MOBILE : 签署人手机号</li>\n<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>\n<li>PERSONAL-IDCARD : 签署人证件号</li>\n<li>TEXT : 单行文本</li>\n<li>MULTI_LINE_TEXT : 多行文本</li>\n<li>CHECK_BOX : 勾选框</li>\n<li>SELECTOR : 选择器</li>\n<li>DIGIT : 数字</li>\n<li>DATE : 日期</li>\n<li>FILL_IMAGE : 图片</li>\n<li>ATTACHMENT : 附件</li>\n<li>EMAIL : 邮箱</li>\n<li>LOCATION : 地址</li>\n<li>EDUCATION : 学历</li>\n<li>GENDER : 性别</li>\n<li>DISTRICT : 省市区</li></ul>",
|
4672
4672
|
"example": "[\"MULTI_LINE_TEXT\"]",
|
4673
4673
|
"member": "string",
|
4674
4674
|
"name": "ShowComponentTypes",
|
@@ -6151,7 +6151,7 @@
|
|
6151
6151
|
},
|
6152
6152
|
{
|
6153
6153
|
"disabled": false,
|
6154
|
-
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n</ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
6154
|
+
"document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器,<font color=\"red\">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>\n</ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
6155
6155
|
"example": "SIGN_SEAL",
|
6156
6156
|
"member": "string",
|
6157
6157
|
"name": "ComponentType",
|
@@ -6272,7 +6272,7 @@
|
|
6272
6272
|
},
|
6273
6273
|
{
|
6274
6274
|
"disabled": false,
|
6275
|
-
"document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋,如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
|
6275
|
+
"document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋,如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
|
6276
6276
|
"example": "ComponentExtra",
|
6277
6277
|
"member": "string",
|
6278
6278
|
"name": "ComponentExtra",
|
@@ -6426,7 +6426,7 @@
|
|
6426
6426
|
},
|
6427
6427
|
{
|
6428
6428
|
"disabled": false,
|
6429
|
-
"document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b>
|
6429
|
+
"document": "**web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件\n<ul><li> <b>false(默认)</b> :可以移动和删除控件</li>\n<li> <b>true</b> : 禁止移动和删除控件</li></ul>",
|
6430
6430
|
"example": "false",
|
6431
6431
|
"member": "bool",
|
6432
6432
|
"name": "ForbidMoveAndDelete",
|
tccli/services/gs/gs_client.py
CHANGED
@@ -693,6 +693,58 @@ def doDescribeAndroidInstanceTasksStatus(args, parsed_globals):
|
|
693
693
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
694
694
|
|
695
695
|
|
696
|
+
def doDistributeFileToAndroidInstances(args, parsed_globals):
|
697
|
+
g_param = parse_global_arg(parsed_globals)
|
698
|
+
|
699
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
700
|
+
cred = credential.CVMRoleCredential()
|
701
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
702
|
+
cred = credential.STSAssumeRoleCredential(
|
703
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
704
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
705
|
+
)
|
706
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
707
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
708
|
+
else:
|
709
|
+
cred = credential.Credential(
|
710
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
711
|
+
)
|
712
|
+
http_profile = HttpProfile(
|
713
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
714
|
+
reqMethod="POST",
|
715
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
716
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
717
|
+
)
|
718
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
719
|
+
if g_param[OptionsDefine.Language]:
|
720
|
+
profile.language = g_param[OptionsDefine.Language]
|
721
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
722
|
+
client = mod.GsClient(cred, g_param[OptionsDefine.Region], profile)
|
723
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
724
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
725
|
+
model = models.DistributeFileToAndroidInstancesRequest()
|
726
|
+
model.from_json_string(json.dumps(args))
|
727
|
+
start_time = time.time()
|
728
|
+
while True:
|
729
|
+
rsp = client.DistributeFileToAndroidInstances(model)
|
730
|
+
result = rsp.to_json_string()
|
731
|
+
try:
|
732
|
+
json_obj = json.loads(result)
|
733
|
+
except TypeError as e:
|
734
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
735
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
736
|
+
break
|
737
|
+
cur_time = time.time()
|
738
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
739
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
740
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
741
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
742
|
+
else:
|
743
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
744
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
745
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
746
|
+
|
747
|
+
|
696
748
|
def doTrylockWorker(args, parsed_globals):
|
697
749
|
g_param = parse_global_arg(parsed_globals)
|
698
750
|
|
@@ -1317,6 +1369,58 @@ def doDescribeAndroidInstances(args, parsed_globals):
|
|
1317
1369
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1318
1370
|
|
1319
1371
|
|
1372
|
+
def doUploadFilesToAndroidInstances(args, parsed_globals):
|
1373
|
+
g_param = parse_global_arg(parsed_globals)
|
1374
|
+
|
1375
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
1376
|
+
cred = credential.CVMRoleCredential()
|
1377
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
1378
|
+
cred = credential.STSAssumeRoleCredential(
|
1379
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
1380
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
1381
|
+
)
|
1382
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
1383
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
1384
|
+
else:
|
1385
|
+
cred = credential.Credential(
|
1386
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
1387
|
+
)
|
1388
|
+
http_profile = HttpProfile(
|
1389
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
1390
|
+
reqMethod="POST",
|
1391
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
1392
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
1393
|
+
)
|
1394
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
1395
|
+
if g_param[OptionsDefine.Language]:
|
1396
|
+
profile.language = g_param[OptionsDefine.Language]
|
1397
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
1398
|
+
client = mod.GsClient(cred, g_param[OptionsDefine.Region], profile)
|
1399
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
1400
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1401
|
+
model = models.UploadFilesToAndroidInstancesRequest()
|
1402
|
+
model.from_json_string(json.dumps(args))
|
1403
|
+
start_time = time.time()
|
1404
|
+
while True:
|
1405
|
+
rsp = client.UploadFilesToAndroidInstances(model)
|
1406
|
+
result = rsp.to_json_string()
|
1407
|
+
try:
|
1408
|
+
json_obj = json.loads(result)
|
1409
|
+
except TypeError as e:
|
1410
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
1411
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
1412
|
+
break
|
1413
|
+
cur_time = time.time()
|
1414
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
1415
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
1416
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
1417
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
1418
|
+
else:
|
1419
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
1420
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
1421
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1422
|
+
|
1423
|
+
|
1320
1424
|
def doResetAndroidInstances(args, parsed_globals):
|
1321
1425
|
g_param = parse_global_arg(parsed_globals)
|
1322
1426
|
|
@@ -2953,6 +3057,7 @@ ACTION_MAP = {
|
|
2953
3057
|
"ModifyAndroidInstancesInformation": doModifyAndroidInstancesInformation,
|
2954
3058
|
"DeleteAndroidInstanceImages": doDeleteAndroidInstanceImages,
|
2955
3059
|
"DescribeAndroidInstanceTasksStatus": doDescribeAndroidInstanceTasksStatus,
|
3060
|
+
"DistributeFileToAndroidInstances": doDistributeFileToAndroidInstances,
|
2956
3061
|
"TrylockWorker": doTrylockWorker,
|
2957
3062
|
"DescribeAndroidInstanceImages": doDescribeAndroidInstanceImages,
|
2958
3063
|
"StartAndroidInstancesApp": doStartAndroidInstancesApp,
|
@@ -2965,6 +3070,7 @@ ACTION_MAP = {
|
|
2965
3070
|
"CreateAndroidInstanceWebShell": doCreateAndroidInstanceWebShell,
|
2966
3071
|
"StartPublishStream": doStartPublishStream,
|
2967
3072
|
"DescribeAndroidInstances": doDescribeAndroidInstances,
|
3073
|
+
"UploadFilesToAndroidInstances": doUploadFilesToAndroidInstances,
|
2968
3074
|
"ResetAndroidInstances": doResetAndroidInstances,
|
2969
3075
|
"RebootAndroidInstances": doRebootAndroidInstances,
|
2970
3076
|
"ModifyAndroidInstanceInformation": doModifyAndroidInstanceInformation,
|