EssClient (tencentcloud-sdk-java 3.1.561 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ess.v20201111.EssClient

public class EssClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明

EssClient(Credential credential, String region)

EssClient(Credential credential, String region, ClientProfile profile)

构造器
构造器和说明
`EssClient(Credential credential, String region)`
`EssClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CancelFlowResponse`	`CancelFlow(CancelFlowRequest req)` 用于撤销签署流程适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。
`CancelMultiFlowSignQRCodeResponse`	`CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)` 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。
`CreateConvertTaskApiResponse`	`CreateConvertTaskApi(CreateConvertTaskApiRequest req)` 创建文件转换任务
`CreateDocumentResponse`	`CreateDocument(CreateDocumentRequest req)` 创建签署流程电子文档适用场景：见创建签署流程接口。
`CreateFlowResponse`	`CreateFlow(CreateFlowRequest req)` 创建签署流程适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
`CreateFlowByFilesResponse`	`CreateFlowByFiles(CreateFlowByFilesRequest req)` 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
`CreateMultiFlowSignQRCodeResponse`	`CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)` 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
`CreateSchemeUrlResponse`	`CreateSchemeUrl(CreateSchemeUrlRequest req)` 获取小程序跳转链接适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
`DescribeFileUrlsResponse`	`DescribeFileUrls(DescribeFileUrlsRequest req)` 查询文件下载URL 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
`DescribeFlowBriefsResponse`	`DescribeFlowBriefs(DescribeFlowBriefsRequest req)` 查询流程摘要适用场景：可用于主动查询某个合同流程的签署状态信息。
`DescribeFlowTemplatesResponse`	`DescribeFlowTemplates(DescribeFlowTemplatesRequest req)` 二期接口-查询模板适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。
`DescribeThirdPartyAuthCodeResponse`	`DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)` 通过AuthCode查询用户是否实名
`GetTaskResultApiResponse`	`GetTaskResultApi(GetTaskResultApiRequest req)` 查询转换任务状态
`StartFlowResponse`	`StartFlow(StartFlowRequest req)` 此接口用于发起流程适用场景：见创建签署流程接口。
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)` 此接口（UploadFiles）用于文件上传。

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - EssClient
```
public EssClient(Credential credential,
                 String region)
```
  - EssClient
```
public EssClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- 方法详细资料
  - CancelFlow
```
public CancelFlowResponse CancelFlow(CancelFlowRequest req)
                              throws TencentCloudSDKException
```
    用于撤销签署流程适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
    
    参数:
    
    req - CancelFlowRequest
    
    返回:
    
    CancelFlowResponse
    
    抛出:
    
    TencentCloudSDKException
  - CancelMultiFlowSignQRCode
```
public CancelMultiFlowSignQRCodeResponse CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
    
    参数:
    
    req - CancelMultiFlowSignQRCodeRequest
    
    返回:
    
    CancelMultiFlowSignQRCodeResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateConvertTaskApi
```
public CreateConvertTaskApiResponse CreateConvertTaskApi(CreateConvertTaskApiRequest req)
                                                  throws TencentCloudSDKException
```
    创建文件转换任务
    
    参数:
    
    req - CreateConvertTaskApiRequest
    
    返回:
    
    CreateConvertTaskApiResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateDocument
```
public CreateDocumentResponse CreateDocument(CreateDocumentRequest req)
                                      throws TencentCloudSDKException
```
    创建签署流程电子文档适用场景：见创建签署流程接口。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
    
    参数:
    
    req - CreateDocumentRequest
    
    返回:
    
    CreateDocumentResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateFlow
```
public CreateFlowResponse CreateFlow(CreateFlowRequest req)
                              throws TencentCloudSDKException
```
    创建签署流程适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
    
    参数:
    
    req - CreateFlowRequest
    
    返回:
    
    CreateFlowResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateFlowByFiles
```
public CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req)
                                            throws TencentCloudSDKException
```
    此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
    
    参数:
    
    req - CreateFlowByFilesRequest
    
    返回:
    
    CreateFlowByFilesResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateMultiFlowSignQRCode
```
public CreateMultiFlowSignQRCodeResponse CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
    
    参数:
    
    req - CreateMultiFlowSignQRCodeRequest
    
    返回:
    
    CreateMultiFlowSignQRCodeResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateSchemeUrl
```
public CreateSchemeUrlResponse CreateSchemeUrl(CreateSchemeUrlRequest req)
                                        throws TencentCloudSDKException
```
    获取小程序跳转链接适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明
    
    参数:
    
    req - CreateSchemeUrlRequest
    
    返回:
    
    CreateSchemeUrlResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeFileUrls
```
public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req)
                                          throws TencentCloudSDKException
```
    查询文件下载URL 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
    
    参数:
    
    req - DescribeFileUrlsRequest
    
    返回:
    
    DescribeFileUrlsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeFlowBriefs
```
public DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req)
                                              throws TencentCloudSDKException
```
    查询流程摘要适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
    
    参数:
    
    req - DescribeFlowBriefsRequest
    
    返回:
    
    DescribeFlowBriefsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeFlowTemplates
```
public DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
                                                    throws TencentCloudSDKException
```
    二期接口-查询模板适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
    
    参数:
    
    req - DescribeFlowTemplatesRequest
    
    返回:
    
    DescribeFlowTemplatesResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeThirdPartyAuthCode
```
public DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
                                                              throws TencentCloudSDKException
```
    通过AuthCode查询用户是否实名
    
    参数:
    
    req - DescribeThirdPartyAuthCodeRequest
    
    返回:
    
    DescribeThirdPartyAuthCodeResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetTaskResultApi
```
public GetTaskResultApiResponse GetTaskResultApi(GetTaskResultApiRequest req)
                                          throws TencentCloudSDKException
```
    查询转换任务状态
    
    参数:
    
    req - GetTaskResultApiRequest
    
    返回:
    
    GetTaskResultApiResponse
    
    抛出:
    
    TencentCloudSDKException
  - StartFlow
```
public StartFlowResponse StartFlow(StartFlowRequest req)
                            throws TencentCloudSDKException
```
    此接口用于发起流程适用场景：见创建签署流程接口。注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
    
    参数:
    
    req - StartFlowRequest
    
    返回:
    
    StartFlowResponse
    
    抛出:
    
    TencentCloudSDKException
  - UploadFiles
```
public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException
```
    此接口（UploadFiles）用于文件上传。适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
    
    参数:
    
    req - UploadFilesRequest
    
    返回:
    
    UploadFilesResponse
    
    抛出:
    
    TencentCloudSDKException

类 EssClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

EssClient

EssClient

方法详细资料

CancelFlow

CancelMultiFlowSignQRCode

CreateConvertTaskApi

CreateDocument

CreateFlow

CreateFlowByFiles

CreateMultiFlowSignQRCode

CreateSchemeUrl

DescribeFileUrls

DescribeFlowBriefs

DescribeFlowTemplates

DescribeThirdPartyAuthCode

GetTaskResultApi

StartFlow

UploadFiles