评价器(Evaluator)

使用前置条件

提示

评价器需要在“政务大厅窗口”模式下启用辅屏的状态下使用
启用辅屏 [点击参考]

# 开启或关闭评价器 useEvaluator

● 接口说明
开启或关闭评价器   
可以通过政务浏览器侧边栏或菜单栏开启或关闭(此方法开启时为使用配置项内的地址进行打开)   
可以通过传入参数实现自定义打开   
当评价器窗口时打开时再调用次窗口将关闭评价器  
● Typescript 类型参考
type ResBody = {
    resultCode: number, resultMessage: string, data: {} 
}

type ReqBody = {
    evaluationUrl?:string,
    isFullscreen?:boolean,
    bounds?:{
        width: number,
        height: number,
        x?: number,
        y?: number,
    }
}

zwexplorer.Evaluator.useEvaluator(
    data: ReqBody, 
    callback?: (res: ResBody)=>void
): Promise<ResBody>
● 参数说明
参数 类型 必填 说明
data.evaluationUrl String 评价页面地址(不传入地址时将使用默认评价器界面)
data.isFullscreen Boolean 是否全屏并置顶
data.disableAudio Boolean 禁止音频播报
data.countDown Number 评价倒计时时长,单位s(默认评价界面)
data.bounds Object 窗口位置(不传入时通过配置页面中设定的屏幕打开)
data.bounds.width Number 窗口位置(宽)(传入bounds为必填)
data.bounds.height Number 窗口位置(高)(传入bounds为必填)
data.bounds.x Number 窗口位置(x轴)(不传入x,y时通过配置页面中设定的屏幕居中显示)
data.bounds.y Number 窗口位置(y轴)
● 返回数据
参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 接口返回的详细数据
res.resultMessage String 接口消息
● 接口示例
zwexplorer.Evaluator.useEvaluator({},(res)=>{
  // 返回数据
})

# 关闭评价器 endEvaluator

● 接口说明
关闭评价器
● Typescript 类型参考
type ResBody = {
    resultCode: number, resultMessage: string, data: {} 
}

zwexplorer.Evaluator.endEvaluator(
    data?: {}, 
    callback?: (res: ResBody)=>void
): Promise<ResBody>
● 返回数据
参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 接口返回的详细数据
res.resultMessage String 接口消息
● 接口示例
zwexplorer.Evaluator.endEvaluator({},(res)=>{
  // 返回数据
})

# 获取评价分数 getScore

● 接口说明
使用默认评价器时获取评价分数,在完成评价15s内完成获取,15s后评价分数将过期
● Typescript 类型参考
type ResBody = {
    resultCode: number, resultMessage: string, data: {
        score: number | null
    } 
}

zwexplorer.Evaluator.getScore(
    data?: {}, 
    callback?: (res: ResBody)=>void
): Promise<ResBody>
● 返回数据
参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 状态码为 0 时,返回评分信息
res.resultMessage String 接口消息
res.data.score Number 正确返回时获得评分成绩
● 接口示例
zwexplorer.Evaluator.getScore({},(res)=>{
  // 返回数据
})

● 评价器对接指南
zwexplorer.Evaluator.useEvaluator({ }, (res) => {
  if (res.resultCode === 0) {
    // 已打开
    zwexplorer.Evaluator.getScore({ }, (res) => {
      // 评价信息返回,正确返回或超时返回
      zwexplorer.Evaluator.endEvaluator({ }, (res) => {
        // 已关闭
      });
    });
  }
});