01 打开文件
## 设置签字人信息
设置签字人身份后,系统自动将签名对象和身份进行绑定,并最终写入PDF文件中,用于验签信息显示。
**代码示例:**
```
WellSign.setHqSignerInfo(userName,signDesc);
```
**接口参数说明:**
- userName
类型:String
说明:签字人名称,会在验签卡片中显示,建议写业务系统中用户名称
- signDesc
类型:String
说明:附加信息,不会在验签卡片信息中显示
## 打开单文件
在用户界面,引入WSPDFView 控件(详细代码及布局文件可参照好签demo)打开文件,
本方法会根据需要自动将服务端文件下载到本地,并拉取文件对应签字数据。
由于该接口是异步耗时操作,请自行添加进度条等遮罩直到回调返回。
**代码示例:**
```
mPdfView.openSingleFile(fileId,
pageViewMode,
new WSProgressCallBack() {
@Override
public void onProgress(int progress) {
Log.e("SDK","打开文件progress:"+progress);
//do something
}
@Override
public void result(boolean success, WSResult result) {
Log.e("SDK",success+":"+result.getMessage());
//do something
}
});
```
**接口参数说明:**
- fileId
类型:String
说明:fileId为已上传到SDKO服务端的文件返回值。
- pageViewMode
类型:int
说明:阅读文件时的翻页方式,目前支持两种翻页方式;
**WSPublicConst.CONTINUOUS_PAGE**:垂直连续翻页(推荐)
**WSPublicConst.SINGLE_PAGE**:单页左右翻页
- syncSignMode
~~类型:boolean
false:不开启
true:开启,会实时加载其他端提交数据。
多人会签场景时使用,可实时显示他人签名、笔迹等~~(暂未提供)
- WSProgressCallBack
类型:WSProgressCallBack
说明:回调函数,返回打开文件结果,以及打开进度
**回调说明:**
- onProgress
参数:progress
类型:int
说明:进度值,范围1~100
- result
参数:success
类型:boolean
说明:执行结果
参数:result
类型:[WSResult](doc:cH4YGgz7)
说明:结果码和结果信息
## 打开多文件
打开多个文件(预先下载文件及数据,非同时显示),一般搭配切换文件接口使用。
由于多文件异步加载,进度无法确定,不返回进度数值。
由于该接口是异步耗时操作,请自行添加进度条等遮罩直到回调返回。
**代码示例:**
```
mPdfView.openMultiFile(fileIdList,
pageViewMode, defaultOpenIndex,
new WSCallBack() {
@Override
public void result(boolean success, WSResult result) {
Log.e("SDK",success+":"+result.getMessage());
//do something
}
});
```
**接口参数说明:**
- fileIdList
类型:List<String>
说明:fileId为已上传到SDKO服务端的文件返回值的集合
- pageViewMode
类型:int
说明:阅读文件时的翻页方式,目前仅支持两种翻页方式;
**WSPublicConst.CONTINUOUS_PAGE**:垂直连续翻页(推荐)
**WSPublicConst.SINGLE_PAGE**:单页左右翻页
- defaultOpenIndex
类型:int
说明:默认显示第几个文件,0为第一个文件。显示文件的第一页。
- syncSignMode
~~类型:boolean
false:不开启
true:开启,会实时加载其他端提交数据。
说明:多人会签场景时使用,可实时显示他人签名、笔迹等~~(暂未提供)
- wSCallBack
类型:WSCallBack
说明:回调函数,返回打开文件结果
**回调说明:**
- result
参数:success
类型:boolean
说明:执行结果
参数:result
类型:[WSResult](doc:cH4YGgz7)
说明:结果码和结果信息
## 切换文件显示
快速调转到该文件的第一页,仅在成功打开多文件后使用。
由于该接口是异步耗时操作,请自行添加进度条等遮罩直到回调返回。
**代码示例:**
```
mPdfView.switchFile(fileId,
new WSCallBack() {
@Override
public void result(boolean success, WSResult result) {
Log.e("SDK",success+":"+result.getMessage());
//do something
}
});
```
**接口参数说明:**
- fileId
类型:String
说明:打开多文件时 文件id集合中的值,
- wSCallBack
类型:WSCallBack
说明:回调函数,返回切换文件结果
**回调说明:**
- result
参数:success
类型:boolean
说明:执行结果
参数:result
类型:[WSResult](doc:cH4YGgz7)
说明:结果码和结果信息
## 打开手机存储的文件
调用本接口,自动将本地文件上传到好签SDKO服务端
(如果后面还需要打开该文件,请使用**打开文件**接口,否则仍调用本接口会产生一条全新的文件记录),
传入的原始文件并不做修改。由于该接口是异步耗时操作,请自行添加进度条等遮罩直到回调成功返回。
**代码示例:**
```
mPdfView.openLocalFile(localFilePath,
pageViewMode,
new WSProgressCallBack() {
@Override
public void onProgress(int progress) {
Log.e("SDK","打开文件progress:"+progress);
//do something
}
@Override
public void result(boolean success, WSResult result) {
Log.e("SDK",success+":"+result.getMessage());
//do something
}
});
```
**接口参数说明:**
- localFilePath
类型:String
说明:本地文件的绝对路径,且扩展名是 .pdf 的文件。
例如:/storage/emulated/0/Download/xxx.pdf
- pageViewMode
类型:int
说明:阅读文件时的翻页方式,目前仅支持两种翻页方式;
**WSPublicConst.CONTINUOUS_PAGE**:垂直连续翻页(推荐)
**WSPublicConst.SINGLE_PAGE**:单页左右翻页
- syncSignMode
~~类型:boolean
false:不开启
true:开启,会实时加载其他端提交数据。
说明:多人会签场景时使用,可实时显示他人签名、笔迹等~~(暂未提供)
- WSProgressCallBack
类型:WSProgressCallBack
说明:回调函数,返回打开本地文件结果,以及打开进度
**回调说明:**
- onProgress
参数:progress
类型:int
说明:进度值,范围1~100
- result
参数:success
类型:boolean
说明:执行结果
参数:result
类型:[WSResult](doc:cH4YGgz7)
说明:结果码和结果信息,result.getData()为SDKO服务端的文件id