com.tencentcloudapi.ess.v20201111

Class EssClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ess.v20201111.EssClient

public class EssClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
EssClient(Credential credential, String region)
EssClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CancelFlowResponse	CancelFlow(CancelFlowRequest req) 用于撤销流程
CreateDocumentResponse	CreateDocument(CreateDocumentRequest req) 创建电子文档
CreateFlowResponse	CreateFlow(CreateFlowRequest req) 创建签署流程
CreateFlowByFilesResponse	CreateFlowByFiles(CreateFlowByFilesRequest req) 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建流程。
CreateSchemeUrlResponse	CreateSchemeUrl(CreateSchemeUrlRequest req) 获取小程序跳转链接 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） 如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明
DescribeFileUrlsResponse	DescribeFileUrls(DescribeFileUrlsRequest req) 查询文件下载URL
DescribeFlowBriefsResponse	DescribeFlowBriefs(DescribeFlowBriefsRequest req) 查询流程摘要
DescribeFlowTemplatesResponse	DescribeFlowTemplates(DescribeFlowTemplatesRequest req) 二期接口-查询模板
DescribeThirdPartyAuthCodeResponse	DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req) 通过AuthCode查询用户是否实名
StartFlowResponse	StartFlow(StartFlowRequest req) 此接口用于发起流程
UploadFilesResponse	UploadFiles(UploadFilesRequest req) 此接口（UploadFiles）用于文件上传。 调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EssClient

public EssClient(Credential credential,
                 String region)

EssClient

public EssClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CancelFlow

public CancelFlowResponse CancelFlow(CancelFlowRequest req)
                              throws TencentCloudSDKException

用于撤销流程

Parameters:

req - CancelFlowRequest

Returns:

CancelFlowResponse

Throws:

TencentCloudSDKException

CreateDocument

public CreateDocumentResponse CreateDocument(CreateDocumentRequest req)
                                      throws TencentCloudSDKException

创建电子文档

Parameters:

req - CreateDocumentRequest

Returns:

CreateDocumentResponse

Throws:

TencentCloudSDKException

CreateFlow

public CreateFlowResponse CreateFlow(CreateFlowRequest req)
                              throws TencentCloudSDKException

创建签署流程

Parameters:

req - CreateFlowRequest

Returns:

CreateFlowResponse

Throws:

TencentCloudSDKException

CreateFlowByFiles

public CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req)
                                            throws TencentCloudSDKException

此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建流程。

Parameters:

req - CreateFlowByFilesRequest

Returns:

CreateFlowByFilesResponse

Throws:

TencentCloudSDKException

CreateSchemeUrl

public CreateSchemeUrlResponse CreateSchemeUrl(CreateSchemeUrlRequest req)
                                        throws TencentCloudSDKException

获取小程序跳转链接 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） 如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明

Parameters:

req - CreateSchemeUrlRequest

Returns:

CreateSchemeUrlResponse

Throws:

TencentCloudSDKException

DescribeFileUrls

public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req)
                                          throws TencentCloudSDKException

查询文件下载URL

Parameters:

req - DescribeFileUrlsRequest

Returns:

DescribeFileUrlsResponse

Throws:

TencentCloudSDKException

DescribeFlowBriefs

public DescribeFlowBriefsResponse DescribeFlowBriefs(DescribeFlowBriefsRequest req)
                                              throws TencentCloudSDKException

查询流程摘要

Parameters:

req - DescribeFlowBriefsRequest

Returns:

DescribeFlowBriefsResponse

Throws:

TencentCloudSDKException

DescribeFlowTemplates

public DescribeFlowTemplatesResponse DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
                                                    throws TencentCloudSDKException

二期接口-查询模板

Parameters:

req - DescribeFlowTemplatesRequest

Returns:

DescribeFlowTemplatesResponse

Throws:

TencentCloudSDKException

DescribeThirdPartyAuthCode

public DescribeThirdPartyAuthCodeResponse DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
                                                              throws TencentCloudSDKException

通过AuthCode查询用户是否实名

Parameters:

req - DescribeThirdPartyAuthCodeRequest

Returns:

DescribeThirdPartyAuthCodeResponse

Throws:

TencentCloudSDKException

StartFlow

public StartFlowResponse StartFlow(StartFlowRequest req)
                            throws TencentCloudSDKException

此接口用于发起流程

Parameters:

req - StartFlowRequest

Returns:

StartFlowResponse

Throws:

TencentCloudSDKException

UploadFiles

public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException

此接口（UploadFiles）用于文件上传。 调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22

Parameters:

req - UploadFilesRequest

Returns:

UploadFilesResponse

Throws:

TencentCloudSDKException