tencentcloud-sdk-nodejs-ess 4.1.258 → 4.1.260
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/package.json
CHANGED
|
@@ -1691,7 +1691,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1691
1691
|
- **可撤回合同状态**：未全部签署完成
|
|
1692
1692
|
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
1693
1693
|
|
|
1694
|
-
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%
|
|
1694
|
+
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%B8%80-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/companyApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
1695
1695
|
|
|
1696
1696
|
|
|
1697
1697
|
注:
|
|
@@ -2001,7 +2001,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
2001
2001
|
- **可撤回合同状态**：未全部签署完成
|
|
2002
2002
|
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
2003
2003
|
|
|
2004
|
-
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%
|
|
2004
|
+
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%B8%80-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/companyApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
2005
2005
|
|
|
2006
2006
|
|
|
2007
2007
|
注:
|
|
@@ -5994,345 +5994,107 @@ export interface DescribeFileCounterSignResultResponse {
|
|
|
5994
5994
|
*/
|
|
5995
5995
|
export interface Component {
|
|
5996
5996
|
/**
|
|
5997
|
-
*
|
|
5998
|
-
|
|
5999
|
-
<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>
|
|
6000
|
-
<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>
|
|
6001
|
-
<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>
|
|
6002
|
-
<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>
|
|
6003
|
-
<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>
|
|
6004
|
-
<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>
|
|
6005
|
-
<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>
|
|
6006
|
-
<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
|
|
6007
|
-
<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>
|
|
6008
|
-
<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li>
|
|
6009
|
-
<li> <b>VIRTUAL_COMBINATION</b> : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容</li></ul>
|
|
6010
|
-
|
|
6011
|
-
**如果是SignComponent签署控件类型，
|
|
6012
|
-
需要根据签署人的类型可选的字段为**
|
|
6013
|
-
* 企业方
|
|
6014
|
-
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
|
|
6015
|
-
<li> <b>SIGN_DATE</b> : 签署日期控件；</li>
|
|
6016
|
-
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
|
|
6017
|
-
<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
6018
|
-
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
6019
|
-
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
|
|
6020
|
-
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
|
|
6021
|
-
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
|
|
6022
|
-
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
|
|
6023
|
-
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
6024
|
-
|
|
6025
|
-
* 个人方
|
|
6026
|
-
<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
|
|
6027
|
-
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
|
|
6028
|
-
<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li>
|
|
6029
|
-
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
|
|
6030
|
-
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
|
|
6031
|
-
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
|
|
6032
|
-
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>
|
|
6033
|
-
|
|
6034
|
-
注：` 表单域的控件不能作为印章和签名控件`
|
|
5997
|
+
* <p><strong>如果是Component填写控件类型，则可选的字段为</strong>：</p><ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li><li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li><li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li><li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li><li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li><li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li><li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li><li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li><li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li><li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li><li> <b>VIRTUAL_COMBINATION</b> : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容</li></ul><p><strong>如果是SignComponent签署控件类型，<br>需要根据签署人的类型可选的字段为</strong></p><ul><li><p>企业方</p><ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li><li> <b>SIGN_DATE</b> : 签署日期控件；</li><li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li><li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li><li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li><li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li><li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul></li><li><p>个人方</p><ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li><li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li><li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li><li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li><li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li><li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul></li></ul><p>注：<code>表单域的控件不能作为印章和签名控件</code></p>
|
|
6035
5998
|
*/
|
|
6036
5999
|
ComponentType: string;
|
|
6037
6000
|
/**
|
|
6038
|
-
*
|
|
6039
|
-
|
|
6001
|
+
* <p><strong>在绝对定位方式和关键字定位方式下</strong>，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。</p>
|
|
6040
6002
|
*/
|
|
6041
6003
|
ComponentHeight: number;
|
|
6042
6004
|
/**
|
|
6043
|
-
*
|
|
6044
|
-
|
|
6005
|
+
* <p><strong>在绝对定位方式和关键字定位方式下</strong>，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。</p>
|
|
6045
6006
|
*/
|
|
6046
6007
|
ComponentWidth: number;
|
|
6047
6008
|
/**
|
|
6048
|
-
*
|
|
6049
|
-
**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。
|
|
6050
|
-
|
|
6051
|
-
注：
|
|
6052
|
-
1. 页码编号是从<font color="red">1</font>开始编号的。
|
|
6053
|
-
2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。
|
|
6009
|
+
* <p><strong>在绝对定位方式方式下</strong>，指定控件所在PDF文件上的页码<br><strong>在使用文件发起的情况下</strong>，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。</p><p>注：</p><ol><li>页码编号是从<font color="red">1</font>开始编号的。</li><li><font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。</li></ol>
|
|
6054
6010
|
*/
|
|
6055
6011
|
ComponentPage: number;
|
|
6056
6012
|
/**
|
|
6057
|
-
*
|
|
6013
|
+
* <p><strong>在绝对定位方式下</strong>，可以指定控件横向位置的位置，单位为pt（点）。</p>
|
|
6058
6014
|
*/
|
|
6059
6015
|
ComponentPosX: number;
|
|
6060
6016
|
/**
|
|
6061
|
-
*
|
|
6017
|
+
* <p><strong>在绝对定位方式下</strong>，可以指定控件纵向位置的位置，单位为pt（点）。</p>
|
|
6062
6018
|
*/
|
|
6063
6019
|
ComponentPosY: number;
|
|
6064
6020
|
/**
|
|
6065
|
-
* <font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
|
|
6021
|
+
* <p><font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0</p>
|
|
6066
6022
|
*/
|
|
6067
6023
|
FileIndex: number;
|
|
6068
6024
|
/**
|
|
6069
|
-
*
|
|
6070
|
-
<ul><li> <b>NORMAL</b> : 绝对定位控件</li>
|
|
6071
|
-
<li> <b>FIELD</b> : 表单域</li>
|
|
6072
|
-
<li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
|
|
6025
|
+
* <p>控件生成的方式：</p><ul><li> <b>NORMAL</b> : 绝对定位控件</li><li> <b>FIELD</b> : 表单域</li><li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
|
|
6073
6026
|
*/
|
|
6074
6027
|
GenerateMode?: string;
|
|
6075
6028
|
/**
|
|
6076
|
-
*
|
|
6077
|
-
|
|
6078
|
-
**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
|
|
6079
|
-
|
|
6080
|
-
**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
|
|
6081
|
-
|
|
6082
|
-
例：
|
|
6083
|
-
|
|
6084
|
-
- 如传入的关键字<font color="red">"^甲方签署^"</font >，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符</font >）进行对应操作。
|
|
6085
|
-
- 如传入的关键字为<font color="red">"甲方签署</font >"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符</font >）都会执行相应操作。
|
|
6086
|
-
|
|
6087
|
-
|
|
6088
|
-
注：`控件ID可以在一个PDF中不可重复`
|
|
6089
|
-
|
|
6090
|
-
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a>
|
|
6091
|
-
|
|
6029
|
+
* <p>控件唯一ID。</p><p><strong>在绝对定位方式方式下</strong>，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。</p><p><strong>在关键字定位方式下</strong>，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。</p><p>例：</p><ul><li>如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。</li><li>如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。</li></ul><p>注：<code>控件ID可以在一个PDF中不可重复</code></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a></p>
|
|
6092
6030
|
*/
|
|
6093
6031
|
ComponentId?: string;
|
|
6094
6032
|
/**
|
|
6095
|
-
*
|
|
6096
|
-
|
|
6097
|
-
**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。
|
|
6098
|
-
|
|
6099
|
-
注：`控件名可以在一个PDF中可以重复`
|
|
6100
|
-
|
|
6101
|
-
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
|
|
6033
|
+
* <p><strong>在绝对定位方式方式下</strong>，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。</p><p><strong>在表单域定位方式下</strong>，ComponentName不仅为控件名，也是表单域名称。</p><p>注：<code>控件名可以在一个PDF中可以重复</code></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a></p>
|
|
6102
6034
|
*/
|
|
6103
6035
|
ComponentName?: string;
|
|
6104
6036
|
/**
|
|
6105
|
-
*
|
|
6106
|
-
<ul><li>false（默认）：可以不填写</li>
|
|
6107
|
-
<li>true ：必须填写此填写控件</li></ul>
|
|
6108
|
-
如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
|
|
6037
|
+
* <p>如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填</p><ul><li>false（默认）：可以不填写</li><li>true ：必须填写此填写控件</li></ul>如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
|
|
6109
6038
|
*/
|
|
6110
6039
|
ComponentRequired?: boolean;
|
|
6111
6040
|
/**
|
|
6112
|
-
*
|
|
6041
|
+
* <p><strong>在通过接口拉取控件信息场景下</strong>，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），<strong>发起合同时候不要填写此字段留空即可</strong></p>
|
|
6113
6042
|
*/
|
|
6114
6043
|
ComponentRecipientId?: string;
|
|
6115
6044
|
/**
|
|
6116
|
-
*
|
|
6117
|
-
|
|
6118
|
-
<font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：
|
|
6119
|
-
<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>
|
|
6120
|
-
<li> <b>FontSize</b>： 范围6 :72</li>
|
|
6121
|
-
<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>
|
|
6122
|
-
<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li>
|
|
6123
|
-
<li> <b>Bold</b>是否加粗：true/false</li>
|
|
6124
|
-
</ul>
|
|
6125
|
-
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12,"Bold":false}`
|
|
6126
|
-
|
|
6127
|
-
<font color="red">ComponentType为DATE时</font>，支持以下参数：
|
|
6128
|
-
<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>
|
|
6129
|
-
<li> <b>FontSize</b>： 范围6 :72</li></ul>
|
|
6130
|
-
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
|
|
6131
|
-
|
|
6132
|
-
<font color="red">ComponentType为WATERMARK时</font>，支持以下参数：
|
|
6133
|
-
<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>
|
|
6134
|
-
<li> <b>FontSize</b>： 范围6 :72</li>
|
|
6135
|
-
<li> <b>Opacity</b>： 透明度，范围0 :1</li>
|
|
6136
|
-
<li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li>
|
|
6137
|
-
<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>
|
|
6138
|
-
<li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li>
|
|
6139
|
-
<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>
|
|
6140
|
-
<b>参数样例</b>：`"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"`
|
|
6141
|
-
|
|
6142
|
-
<font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：
|
|
6143
|
-
<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>
|
|
6144
|
-
<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
|
|
6145
|
-
|
|
6146
|
-
<font color="red">ComponentType为SELECTOR时</font>，支持以下参数：
|
|
6147
|
-
<ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li>
|
|
6148
|
-
</ul>
|
|
6149
|
-
|
|
6150
|
-
<font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式
|
|
6151
|
-
<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
|
|
6152
|
-
<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
|
|
6153
|
-
<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
|
|
6154
|
-
<li> <b>ESIGN</b> : 个人印章类型</li>
|
|
6155
|
-
<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>
|
|
6156
|
-
<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
|
|
6157
|
-
<b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
|
|
6158
|
-
印章的对应关系参考下图
|
|
6159
|
-
<br><br>
|
|
6160
|
-
|
|
6161
|
-
<font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
|
|
6162
|
-
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
|
|
6163
|
-
<li> <b>CONTRACT</b> : 合同专用章</li>
|
|
6164
|
-
<li> <b>FINANCE</b> : 财务专用章</li>
|
|
6165
|
-
<li> <b>PERSONNEL</b> : 人事专用章</li>
|
|
6166
|
-
<li> <b>OTHER</b> : 其他</li>
|
|
6167
|
-
</ul>
|
|
6168
|
-
<b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
|
|
6169
|
-
|
|
6170
|
-
<font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
|
|
6171
|
-
<ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋"，如果不填默认为"黑体"</li>
|
|
6172
|
-
<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>
|
|
6173
|
-
<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>
|
|
6174
|
-
<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>
|
|
6175
|
-
<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
|
|
6176
|
-
如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
|
|
6177
|
-
特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
|
|
6178
|
-
<b>参数样例</b>： ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
|
|
6179
|
-
|
|
6180
|
-
<font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：
|
|
6181
|
-
<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
|
|
6182
|
-
<b>参数样例</b>：` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
|
|
6183
|
-
|
|
6184
|
-
<font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：
|
|
6185
|
-
<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>
|
|
6186
|
-
<b>参数样例</b>：`{"Opacity":0.7}`
|
|
6187
|
-
|
|
6188
|
-
<font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：
|
|
6189
|
-
<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>
|
|
6190
|
-
<b>参数样例</b>：`{"UseSealSize":true}`
|
|
6191
|
-
|
|
6192
|
-
<font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：
|
|
6193
|
-
<ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li>
|
|
6194
|
-
<li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul>
|
|
6195
|
-
<b>参数样例</b>：`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`
|
|
6196
|
-
|
|
6197
|
-
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
|
|
6198
|
-
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
|
|
6199
|
-
场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
|
|
6200
|
-
<b>参数样例</b>：` "{"IgnoreKeywordError":1}"`
|
|
6201
|
-
|
|
6202
|
-
<font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：
|
|
6203
|
-
<ul>
|
|
6204
|
-
<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>
|
|
6205
|
-
<b>参数样例</b>：<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
|
|
6206
|
-
<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>
|
|
6207
|
-
ChildrenComponent结构体定义:
|
|
6208
|
-
<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>子控件提示语<tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> </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>
|
|
6209
|
-
<b>参数样例</b>：
|
|
6210
|
-
|
|
6211
|
-
输入:
|
|
6212
|
-
<pre>
|
|
6213
|
-
{
|
|
6214
|
-
ChildrenComponents: [
|
|
6215
|
-
{
|
|
6216
|
-
ComponentType: SIGN_SIGNATURE,
|
|
6217
|
-
ComponentName: 个人签名,
|
|
6218
|
-
Placeholder: 请签名,
|
|
6219
|
-
ComponentOffsetX: 10,
|
|
6220
|
-
ComponentOffsetY: 30,
|
|
6221
|
-
ComponentWidth: 119,
|
|
6222
|
-
ComponentHeight: 43,
|
|
6223
|
-
ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]}
|
|
6224
|
-
},
|
|
6225
|
-
{
|
|
6226
|
-
ComponentType: SIGN_SELECTOR,
|
|
6227
|
-
ComponentName: 是否同意此协议,
|
|
6228
|
-
Placeholder: ,
|
|
6229
|
-
ComponentOffsetX: 50,
|
|
6230
|
-
ComponentOffsetY: 130,
|
|
6231
|
-
ComponentWidth: 120,
|
|
6232
|
-
ComponentHeight: 43,
|
|
6233
|
-
ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false}
|
|
6234
|
-
},
|
|
6235
|
-
{
|
|
6236
|
-
ComponentType: SIGN_MULTI_LINE_TEXT,
|
|
6237
|
-
ComponentName: 批注附言,
|
|
6238
|
-
Placeholder: ,
|
|
6239
|
-
ComponentOffsetX: 150,
|
|
6240
|
-
ComponentOffsetY: 300,
|
|
6241
|
-
ComponentWidth: 200,
|
|
6242
|
-
ComponentHeight: 86,
|
|
6243
|
-
ComponentExtra:
|
|
6244
|
-
}
|
|
6245
|
-
]
|
|
6246
|
-
}
|
|
6247
|
-
</pre>
|
|
6248
|
-
</ul>
|
|
6249
|
-
|
|
6045
|
+
* <p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过<strong>ComponentTypeLimit</strong>参数控制签名方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图<br><br><p><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过<strong>ComponentTypeLimit</strong>参数控制签署方签署时要使用的印章类型，支持指定以下印章类型</p><ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋"，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{"Opacity":0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{"UseSealSize":true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul><b>参数样例</b>：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>"{"IgnoreKeywordError":1}"</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<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>ComponentValue</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><b>参数样例</b>：<p>输入:</p><pre>{ ChildrenComponents: [ { ComponentType: SIGN_SIGNATURE, ComponentName: 个人签名, Placeholder: 请签名, ComponentOffsetX: 10, ComponentOffsetY: 30, ComponentWidth: 119, ComponentHeight: 43, ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]} }, { ComponentType: SIGN_SELECTOR, ComponentName: 是否同意此协议, Placeholder: , ComponentOffsetX: 50, ComponentOffsetY: 130, ComponentWidth: 120, ComponentHeight: 43, ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false} }, { ComponentType: SIGN_MULTI_LINE_TEXT, ComponentName: 批注附言, Placeholder: , ComponentOffsetX: 150, ComponentOffsetY: 300, ComponentWidth: 200, ComponentHeight: 86, ComponentExtra: } ]}</pre></ul>
|
|
6250
6046
|
*/
|
|
6251
6047
|
ComponentExtra?: string;
|
|
6252
6048
|
/**
|
|
6253
|
-
*
|
|
6049
|
+
* <p><strong>在通过接口拉取控件信息场景下</strong>，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，<strong>发起合同时候不要填写此字段留空即可</strong></p>
|
|
6254
6050
|
*/
|
|
6255
6051
|
IsFormType?: boolean;
|
|
6256
6052
|
/**
|
|
6257
|
-
*
|
|
6258
|
-
<ul><li> <b>TEXT</b> : 文本内容</li>
|
|
6259
|
-
<li> <b>MULTI_LINE_TEXT</b> : 文本内容，可以用 \n 来控制换行位置 </li>
|
|
6260
|
-
<li> <b>CHECK_BOX</b> : true/false</li>
|
|
6261
|
-
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
|
|
6262
|
-
<li> <b>SELECTOR</b> : 选项值</li>
|
|
6263
|
-
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
|
|
6264
|
-
<li> <b>DATE</b> : 格式化为：xxxx年xx月xx日（例如2024年05年28日）</li>
|
|
6265
|
-
<li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>
|
|
6266
|
-
<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>
|
|
6267
|
-
|
|
6268
|
-
|
|
6269
|
-
<b>控件值约束说明</b>：
|
|
6270
|
-
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
|
|
6271
|
-
注： `部分特殊控件需要在控制台配置模板形式创建`
|
|
6053
|
+
* <p>控件填充vaule，ComponentType和传入值类型对应关系：</p><ul><li> <b>TEXT</b> : 文本内容</li><li> <b>MULTI_LINE_TEXT</b> : 文本内容，可以用 \n 来控制换行位置 </li><li> <b>CHECK_BOX</b> : true/false</li><li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li><li> <b>SELECTOR</b> : 选项值</li><li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li><li> <b>DATE</b> : 格式化为：xxxx年xx月xx日（例如2024年05年28日）</li><li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li><li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul><p><b>控件值约束说明</b>：</p><table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>注： <code>部分特殊控件需要在控制台配置模板形式创建</code>
|
|
6272
6054
|
*/
|
|
6273
6055
|
ComponentValue?: string;
|
|
6274
6056
|
/**
|
|
6275
|
-
*
|
|
6276
|
-
注意： `向左调整设置为负数， 向右调整设置成正数`
|
|
6057
|
+
* <p><strong>如果控件是关键字定位方式</strong>，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。<br>注意： <code>向左调整设置为负数， 向右调整设置成正数</code></p>
|
|
6277
6058
|
*/
|
|
6278
6059
|
OffsetX?: number;
|
|
6279
6060
|
/**
|
|
6280
|
-
*
|
|
6281
|
-
注意： `向上调整设置为负数， 向下调整设置成正数`
|
|
6061
|
+
* <p><strong>如果控件是关键字定位方式</strong>，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。<br>注意： <code>向上调整设置为负数， 向下调整设置成正数</code></p>
|
|
6282
6062
|
*/
|
|
6283
6063
|
OffsetY?: number;
|
|
6284
6064
|
/**
|
|
6285
|
-
*
|
|
6286
|
-
<ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li>
|
|
6287
|
-
<li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>
|
|
6288
|
-
|
|
6289
|
-
在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。
|
|
6065
|
+
* <p><strong>如果控件是关键字定位方式</strong>，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。</p><ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li><li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul><p>在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。</p>
|
|
6290
6066
|
*/
|
|
6291
6067
|
KeywordOrder?: string;
|
|
6292
6068
|
/**
|
|
6293
|
-
*
|
|
6069
|
+
* <p><strong>如果控件是关键字定位方式</strong>，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。</p>
|
|
6294
6070
|
*/
|
|
6295
6071
|
KeywordPage?: number;
|
|
6296
6072
|
/**
|
|
6297
|
-
*
|
|
6298
|
-
<ul><li> <b>Middle</b> :居中</li>
|
|
6299
|
-
<li> <b>Below</b> :正下方</li>
|
|
6300
|
-
<li> <b>Right</b> :正右方</li>
|
|
6301
|
-
<li> <b>LowerRight</b> :右下角</li>
|
|
6302
|
-
<li> <b>UpperRight</b> :右上角。</li></ul>
|
|
6303
|
-
示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
|
|
6073
|
+
* <p><strong>如果控件是关键字定位方式</strong>，关键字生成的区域的对齐方式， 可以设置下面的值</p><ul><li> <b>Middle</b> :居中</li><li> <b>Below</b> :正下方</li><li> <b>Right</b> :正右方</li><li> <b>LowerRight</b> :右下角</li><li> <b>UpperRight</b> :右上角。</li></ul>示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
|
|
6304
6074
|
*/
|
|
6305
6075
|
RelativeLocation?: string;
|
|
6306
6076
|
/**
|
|
6307
|
-
*
|
|
6308
|
-
|
|
6309
|
-
注意：关键字索引是从0开始计数的
|
|
6077
|
+
* <p><strong>如果控件是关键字定位方式</strong>，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。</p><p>注意：关键字索引是从0开始计数的</p>
|
|
6310
6078
|
*/
|
|
6311
6079
|
KeywordIndexes?: Array<number | bigint>;
|
|
6312
6080
|
/**
|
|
6313
|
-
*
|
|
6314
|
-
<ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li>
|
|
6315
|
-
<li>true：锁定控件值，在页面无法编辑控件值</li></ul>
|
|
6081
|
+
* <p><strong>web嵌入发起合同场景下</strong>， 是否锁定填写和签署控件值不允许嵌入页面进行编辑</p><ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li><li>true：锁定控件值，在页面无法编辑控件值</li></ul>
|
|
6316
6082
|
*/
|
|
6317
6083
|
LockComponentValue?: boolean;
|
|
6318
6084
|
/**
|
|
6319
|
-
*
|
|
6320
|
-
<ul><li> <b>false（默认）</b> :可以移动和删除控件</li>
|
|
6321
|
-
<li> <b>true</b> : 禁止移动和删除控件</li></ul>
|
|
6085
|
+
* <p><strong>web嵌入发起合同场景下</strong>，是否禁止移动和删除填写和签署控件</p><ul><li> <b>false（默认）</b> :可以移动和删除控件</li><li> <b>true</b> : 禁止移动和删除控件</li></ul>
|
|
6322
6086
|
*/
|
|
6323
6087
|
ForbidMoveAndDelete?: boolean;
|
|
6324
6088
|
/**
|
|
6325
|
-
* <font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
|
|
6089
|
+
* <p><font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12</p>
|
|
6326
6090
|
*/
|
|
6327
6091
|
ComponentDateFontSize?: number;
|
|
6328
6092
|
/**
|
|
6329
|
-
* <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID
|
|
6093
|
+
* <p><font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识</p>
|
|
6330
6094
|
*/
|
|
6331
6095
|
ChannelComponentId?: string;
|
|
6332
6096
|
/**
|
|
6333
|
-
* <font color="red">【暂未使用】</font
|
|
6334
|
-
<ul><li> <b>0</b> :平台指定；</li>
|
|
6335
|
-
<li> <b>1</b> :用户自定义</li></ul>
|
|
6097
|
+
* <p><font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。</p><ul><li> <b>0</b> :平台指定；</li><li> <b>1</b> :用户自定义</li></ul>
|
|
6336
6098
|
*/
|
|
6337
6099
|
ChannelComponentSource?: number;
|
|
6338
6100
|
}
|
|
@@ -7899,7 +7661,7 @@ export interface CreateIntegrationRoleRequest {
|
|
|
7899
7661
|
*/
|
|
7900
7662
|
export interface CancelOrganizationFlowsResponse {
|
|
7901
7663
|
/**
|
|
7902
|
-
* <p>全量撤销企业合同任务编号，为32位字符串，可用于<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CancelOrganizationFlows">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%
|
|
7664
|
+
* <p>全量撤销企业合同任务编号，为32位字符串，可用于<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CancelOrganizationFlows">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%B8%80-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">全量撤销企业合同任务结果回调</a></p>
|
|
7903
7665
|
*/
|
|
7904
7666
|
TaskId?: string;
|
|
7905
7667
|
/**
|