cn.tign.hz.factory.base

## 类 SignFile

- java.lang.Object
- - cn.tign.hz.factory.base.SignFile

-     public class SignFile
      extends java.lang.Object

  悟空API签署服务功能类

- - ### 构造器概要

    构造器
    构造器和说明
    `SignFile()`

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static cn.tign.hz.factory.signfile.signflows.ArchiveSignFlow` | `archiveSignFlow(java.lang.String flowId)` 签署流程归档
    `static cn.tign.hz.factory.antfinsign.CheckAntfinNotary` | `checkAntfinNotary(java.lang.String docHash, java.lang.String antTxHash)` 核验签署文件上链信息
    `static cn.tign.hz.factory.signfile.attachments.CreateAttachments` | `createAttachments(java.lang.String flowId, cn.tign.hz.bean.Attachments attachments)` 流程附件添加
    `static cn.tign.hz.factory.signfile.signfields.CreateAutoSign` | `createAutoSign(java.lang.String flowId, cn.tign.hz.bean.Signfields signfields)` 添加签署方自动盖章签署区
    `static cn.tign.hz.factory.signfile.documents.CreateDocuments` | `createDocuments(java.lang.String flowId, cn.tign.hz.bean.Docs docs)` 流程文档添加
    `static cn.tign.hz.factory.signfile.CreateFlowOneStep` | `createFlowOneStep(cn.tign.hz.bean.Docs docs, cn.tign.hz.bean.FlowInfo flowInfo, cn.tign.hz.bean.Signers signers)` 悟空API一步发起签署
    `static cn.tign.hz.factory.signfile.signfields.CreateHandSign` | `createHandSign(java.lang.String flowId, cn.tign.hz.bean.Signfields signfields)` 添加手动盖章签署区
    `static cn.tign.hz.factory.signfile.signfields.CreatePlatformSign` | `createPlatformSign(java.lang.String flowId, cn.tign.hz.bean.Signfields signfields)` 添加平台自动盖章签署区
    `static cn.tign.hz.factory.signfile.signflows.CreateSignFlow` | `createSignFlow(java.lang.String businessScene)` 签署流程创建
    `static cn.tign.hz.factory.signfile.datasign.DataSign` | `dataSign(java.lang.String data, java.lang.String type)` 平台方&平台用户文本签
    `static cn.tign.hz.factory.signfile.datasign.DataVerify` | `dataVerify(java.lang.String data, java.lang.String signResult)`
    `static cn.tign.hz.factory.signfile.attachments.DeleteAttachments` | `deleteAttachments(java.lang.String flowId, java.lang.String fileIds)` 流程附件删除
    `static cn.tign.hz.factory.signfile.documents.DeleteDocuments` | `deleteDocuments(java.lang.String flowId, java.lang.String fileIds)` 流程文档删除
    `static cn.tign.hz.factory.signfile.signfields.DeleteSignFields` | `deleteSignFields(java.lang.String flowId, java.lang.String signfieldIds)` 删除签署区
    `static cn.tign.hz.factory.signfile.documents.DownDocuments` | `downDocuments(java.lang.String flowId)` 流程文档下载
    `static cn.tign.hz.factory.signfile.signers.GetFileSignUrl` | `getFileSignUrl(java.lang.String flowId, java.lang.String accountId)` 获取签署地址
    `static cn.tign.hz.factory.signfile.signflows.GetVoucherSignFlow` | `getVoucherSignFlow(java.lang.String flowId)` 流程签署数据存储凭据
    `static cn.tign.hz.factory.signfile.pdfverify.PdfVerify` | `pdfVerify(java.lang.String fileId)` PDF文件验签
    `static cn.tign.hz.factory.signfile.attachments.QryAttachments` | `qryAttachments(java.lang.String flowId)` 流程附件列表
    `static cn.tign.hz.factory.antfinsign.QrySignAntPushInfo` | `qrySignAntPushInfo(java.lang.String flowId)` 查询签署文件上链信息
    `static cn.tign.hz.factory.signfile.signers.QrySigners` | `qrySigners(java.lang.String flowId)` 流程签署人列表
    `static cn.tign.hz.factory.signfile.signfields.QrySignFields` | `qrySignFields(java.lang.String flowId)` 查询签署区列表
    `static cn.tign.hz.factory.signfile.signflows.QrySignFlow` | `qrySignFlow(java.lang.String flowId)` 签署流程查询
    `static cn.tign.hz.factory.signfile.signflows.RevokeSignFlow` | `revokeSignFlow(java.lang.String flowId)` 签署流程撤销
    `static cn.tign.hz.factory.signfile.signers.RushSign` | `rushSign(java.lang.String flowId)` 流程签署人催签
    `static cn.tign.hz.factory.other.SearchWordsPosition` | `searchWordsPosition(java.lang.String fileId, java.lang.String keywords)` 搜索关键字坐标
    `static cn.tign.hz.factory.signfile.signflows.StartSignFlow` | `startSignFlow(java.lang.String flowId)` 签署流程开启

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

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

- - ### 构造器详细资料

    - #### SignFile

          public SignFile()

  - ### 方法详细资料

    - #### createFlowOneStep

          public static cn.tign.hz.factory.signfile.CreateFlowOneStep createFlowOneStep(cn.tign.hz.bean.Docs docs,
                                                                                        cn.tign.hz.bean.FlowInfo flowInfo,
                                                                                        cn.tign.hz.bean.Signers signers)

      悟空API一步发起签署
      参数:
        `docs` -
        `flowInfo` -
        `signers` -
      返回:

    - #### getFileSignUrl

          public static cn.tign.hz.factory.signfile.signers.GetFileSignUrl getFileSignUrl(java.lang.String flowId,
                                                                                          java.lang.String accountId)

      获取签署地址
      参数:
        `flowId` - 流程id
        `accountId` - 签署人账号id
      返回:

    - #### startSignFlow

          public static cn.tign.hz.factory.signfile.signflows.StartSignFlow startSignFlow(java.lang.String flowId)

      签署流程开启
      参数:
        `flowId` - 流程id
      返回:

    - #### createSignFlow

          public static cn.tign.hz.factory.signfile.signflows.CreateSignFlow createSignFlow(java.lang.String businessScene)

      签署流程创建
      参数:
        `businessScene` - 文件主题
      返回:

    - #### qrySignFlow

          public static cn.tign.hz.factory.signfile.signflows.QrySignFlow qrySignFlow(java.lang.String flowId)

      签署流程查询
      参数:
        `flowId` - 流程id
      返回:

    - #### revokeSignFlow

          public static cn.tign.hz.factory.signfile.signflows.RevokeSignFlow revokeSignFlow(java.lang.String flowId)

      签署流程撤销
      参数:
        `flowId` - 流程id
      返回:

    - #### archiveSignFlow

          public static cn.tign.hz.factory.signfile.signflows.ArchiveSignFlow archiveSignFlow(java.lang.String flowId)

      签署流程归档
      参数:
        `flowId` - 流程id
      返回:

    - #### getVoucherSignFlow

          public static cn.tign.hz.factory.signfile.signflows.GetVoucherSignFlow getVoucherSignFlow(java.lang.String flowId)

      流程签署数据存储凭据
      参数:
        `flowId` -
      返回:

    - #### createDocuments

          public static cn.tign.hz.factory.signfile.documents.CreateDocuments createDocuments(java.lang.String flowId,
                                                                                              cn.tign.hz.bean.Docs docs)

      流程文档添加
      参数:
        `flowId` - 流程id
        `docs` - 文档列表数据
      返回:

    - #### downDocuments

          public static cn.tign.hz.factory.signfile.documents.DownDocuments downDocuments(java.lang.String flowId)

      流程文档下载
      参数:
        `flowId` - 流程id
      返回:

    - #### deleteDocuments

          public static cn.tign.hz.factory.signfile.documents.DeleteDocuments deleteDocuments(java.lang.String flowId,
                                                                                              java.lang.String fileIds)

      流程文档删除
      参数:
        `flowId` - 流程id
        `fileIds` - 文档id列表,多个id使用“，”分隔
      返回:

    - #### createAttachments

          public static cn.tign.hz.factory.signfile.attachments.CreateAttachments createAttachments(java.lang.String flowId,
                                                                                                    cn.tign.hz.bean.Attachments attachments)

      流程附件添加
      参数:
        `flowId` - 流程id
        `attachments` - 附件列表数据
      返回:

    - #### qryAttachments

          public static cn.tign.hz.factory.signfile.attachments.QryAttachments qryAttachments(java.lang.String flowId)

      流程附件列表
      参数:
        `flowId` - 流程id
      返回:

    - #### deleteAttachments

          public static cn.tign.hz.factory.signfile.attachments.DeleteAttachments deleteAttachments(java.lang.String flowId,
                                                                                                    java.lang.String fileIds)

      流程附件删除
      参数:
        `flowId` - 流程id
        `fileIds` - 文档id列表,多个id使用“，”分隔
      返回:

    - #### qrySignFields

          public static cn.tign.hz.factory.signfile.signfields.QrySignFields qrySignFields(java.lang.String flowId)

      查询签署区列表
      参数:
        `flowId` - 流程id
      返回:

    - #### createPlatformSign

          public static cn.tign.hz.factory.signfile.signfields.CreatePlatformSign createPlatformSign(java.lang.String flowId,
                                                                                                     cn.tign.hz.bean.Signfields signfields)

      添加平台自动盖章签署区
      参数:
        `flowId` - 流程id
        `signfields` - 签署区列表数据
      返回:

    - #### createAutoSign

          public static cn.tign.hz.factory.signfile.signfields.CreateAutoSign createAutoSign(java.lang.String flowId,
                                                                                             cn.tign.hz.bean.Signfields signfields)

      添加签署方自动盖章签署区
      参数:
        `flowId` - 流程id
        `signfields` - 签署区列表数据
      返回:

    - #### createHandSign

          public static cn.tign.hz.factory.signfile.signfields.CreateHandSign createHandSign(java.lang.String flowId,
                                                                                             cn.tign.hz.bean.Signfields signfields)

      添加手动盖章签署区
      参数:
        `flowId` - 流程id
        `signfields` - 签署区列表数据
      返回:

    - #### deleteSignFields

          public static cn.tign.hz.factory.signfile.signfields.DeleteSignFields deleteSignFields(java.lang.String flowId,
                                                                                                 java.lang.String signfieldIds)

      删除签署区
      参数:
        `flowId` - 流程id
        `signfieldIds` - 签署区id列表，逗号分割
      返回:

    - #### qrySigners

          public static cn.tign.hz.factory.signfile.signers.QrySigners qrySigners(java.lang.String flowId)

      流程签署人列表
      参数:
        `flowId` - 流程id
      返回:

    - #### rushSign

          public static cn.tign.hz.factory.signfile.signers.RushSign rushSign(java.lang.String flowId)

      流程签署人催签
      参数:
        `flowId` - 流程id
      返回:

    - #### dataSign

          public static cn.tign.hz.factory.signfile.datasign.DataSign dataSign(java.lang.String data,
                                                                               java.lang.String type)

      平台方&平台用户文本签
      参数:
        `data` - 待签文本
        `type` - 待签文本类型：
      返回:

    - #### dataVerify

          public static cn.tign.hz.factory.signfile.datasign.DataVerify dataVerify(java.lang.String data,
                                                                                   java.lang.String signResult)

      参数:
        `data` - 文本签原文
        `signResult` - 文本签返回的签署结果
      返回:

    - #### pdfVerify

          public static cn.tign.hz.factory.signfile.pdfverify.PdfVerify pdfVerify(java.lang.String fileId)

      PDF文件验签
      参数:
        `fileId` - 文件id
      返回:

    - #### qrySignAntPushInfo

          public static cn.tign.hz.factory.antfinsign.QrySignAntPushInfo qrySignAntPushInfo(java.lang.String flowId)

      查询签署文件上链信息
      参数:
        `flowId` - 签署流程ID
      返回:

    - #### checkAntfinNotary

          public static cn.tign.hz.factory.antfinsign.CheckAntfinNotary checkAntfinNotary(java.lang.String docHash,
                                                                                          java.lang.String antTxHash)

      核验签署文件上链信息
      参数:
        `docHash` - 签署文件的哈希值
        `antTxHash` - 蚂蚁区块链统一证据编号
      返回:

    - #### searchWordsPosition

          public static cn.tign.hz.factory.other.SearchWordsPosition searchWordsPosition(java.lang.String fileId,
                                                                                         java.lang.String keywords)

      搜索关键字坐标
      参数:
        `fileId` - 文档id
        `keywords` - 关键字列表，逗号分割
      返回: