Kai12.LocalReinforce前端接口列表 v1.17.0

需要引用的文件

--jquery.js

--http://asset.kai12.cn/js/jquery.localreinforce.js

如何调用

$.localReinforce({

//必要，action 接口名称，类型string
action : 'action',

//必要，param 接口参数，类型object
param : {param},

//可选，complete 请求成功时回调（无论返回结果是success或者error），类型function
//参数json为返回完整的返回结果
complete : function(json){

},

//可选，success 请求成功返回success时回调，类型function
//参数data只含有返回结果的data部分
success : function(data){

},

//可选，error 请求成功返回error时回调，类型function
//参数data只含有返回结果的data部分
error : function(data){

},

//可选，fail 请求失败时回调，类型function
//导致请求不成功的情况：(1)用户本地未安装程序，(2)用户未启动程序
fail : function(){

//提供有用的方法

$.localReinforce('installUrl')
//该方法返回当前Install安装包的地址，给用户下载
//请使用类似 window.open($.localReinforce('installUrl'))来提示用户下载文件

$.localReinforce('protocolLaunch');
//该方法执行之后，以伪协议启动本地已安装的程序

},

//可选，always 无论请求成功或失败时回调，类型function
//可在此执行必然的UI调整
always : function(){

}

})

接口列表

通用返回

json

  • 当action不存在或不为string，或者param不存在或不为object（有效json）时，返回
    {"status":"error","data":{"message":"请求无效"}}

  • 当并没有action所对应接口时，将调用默认接口，返回
    {"status":"success","data":{"message":"运行中"}}

  • 当程序正在自动更新时，返回
    {"status":"error","data":{"message":"程序正在进行必要的更新，请更新完毕后重试"}}

  • 当某个接口必要的参数未传或为空时，返回
    {"status":"error","data":{"message":"必要的参数未传或为空"}}

openfiledialog 调用文件打开窗口

action

openfiledialog
param

{accept : '', multiselect : true/false, defaultFileName : ''}

accept：可选，文件类型(string)，取值：word，excel，powerpoint，video, test，如没有指定，则默认为全部文件类型

multiselect：可选，是否允许多选(bool)，默认false

defaultFileName：可选，默认文件名(string)，带文件扩展名后缀
json

  • 当用户未选择任何文件时，返回
    {"status":"error","data":{"message":"未选择文件"}}

  • 仅当multiselect为true，且用户选择了文件时，返回
    {"status":"success","data":["_文件路径_",……]}

  • 当用户选择了文件时，返回
    {"status":"success","data":{"filePath":"","fileSize":""}}
    filePath：文件路径
    fileSize：文件大小

  • 当用户选择了文件，且文件为Excel文件时，返回
    {"status":"success","data":{"filePath":"","fileSize":"","sheets":[]}}
    filePath：文件路径
    fileSize：文件大小
    sheets：Excel工作簿名称集

savefiledialog 调用文件保存窗口

action

savefiledialog
param

{accept : '', defaultFileName : ''}

accept：可选，文件类型(string)，取值：word，excel，powerpoint，video，如没有指定，则为全部文件类型

defaultFileName：可选，默认文件名(string)，带文件扩展名后缀
json

  • 当用户未选择任何文件时，返回
    {"status":"error","data":{"message":"未选择文件"}}

  • 当用户选择了文件时，返回
    {"status":"success","data":{"filePath":""}}
    filePath：文件路径

folderdialog 调用文件夹窗口

action

folderdialog
param

{}
json

  • 当用户未选择任何文件夹时，返回
    {"status":"error","data":{"message":"未选择文件夹"}}

  • 当用户选择了文件夹时，返回
    {"status":"success","data":{"folderPath":""}}
    folderPath：文件夹路径

另：accept对应文件扩展名后缀

word Office Word文件

.doc
.docx
excel Office Excel文件

.xls
.xlsx
power
point		 Office PowerPoint文件

.ppt
.pptx
audio 音频文件

.mp3
.wmv
.wma
.wav
.acc

video 视频文件

.mp4
.wmv
.avi
.3gp
.rm
.asf
.asx
.rmvb
.flv
.mkv
.mov
.mpeg
.mpg
.mpe
.m4v
.dat
.vob
.ogg

test Kai12 Test文件

.test

wordtohtml Word文件转为Html

action

wordtohtml
param

{filePath : ''}

filePath：必要，Word文件路径(string)，一般由openfiledialog接口返回
json

  • 当Word文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是Word文档格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当选择的Word文件文件名超过限制（32位Office最多支持255个字节）时，返回
    {"status":"error","data":{"message":"文件名长度超过255个字节"}}

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当Word文件被转为html文件内容时，返回
    {"status":"success","data":{"html":""}}
    html：html文件内容

htmltoword Html转为Word文件

action

htmltoword
param

{filePath : '',html : ''}

filePath：必要，Word文件路径(string)，一般由savefiledialog接口返回

html：可选，html文件内容(string)
json

  • 当Word文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是Word文档格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当选择的Word文件文件名长度超过限制（32位Office最多支持255个字节）时，返回
    {"status":"error","data":{"message":"文件名长度超过255个字节"}}

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当html文件内容被转为Word文件时，返回
    {"status":"success","data":{"message":"文件已保存到_文件路径_"}}

clipboardpaste 从剪贴板上粘贴内容

action

clipboardpaste
param

{}
json

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当从剪贴板上成功获得html文件内容时，返回
    {"status":"success","data":{"html":""}}
    html：html文件内容

exceltohtml Excel文件转为Html

action

exceltohtml
param

{filePath : '',sheetName : ''}

filePath：必要，Excel文件路径(string)，一般由openfiledialog接口返回

sheetName：必要，Excel工作簿名称(string)，一般在openfiledialog接口返回中获取
json

  • 当Excel文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是Excel文档格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当选择的Excel文件文件名长度超过限制（32位Office最多支持255个字节）时，返回
    {"status":"error","data":{"message":"文件名长度超过255个字节"}}

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当Excel文件被转为html文件内容时，返回
    {"status":"success","data":{"html":""}}
    html：html文件内容

powerpointtohtml PowerPoint文件转为Html

action

powerpointtohtml
param

{filePath : ''}

filePath：必要，PowerPoint文件路径(string)，一般由openfiledialog接口返回
json

  • 当PowerPoint文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是PowerPoint文档格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当选择的PowerPoint文件文件名长度超过限制（32位Office最多支持255个字节）时，返回
    {"status":"error","data":{"message":"文件名长度超过255个字节"}}

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当PowerPoint文件被转为html文件内容时，返回
    {"status":"success","data":{"html":""}}
    html：html文件内容

officeonlineedit Office文档在线编辑

action

officeonlineedit
param

{fileUrl : '',fileName:'',uploadUrl:'',uploadToken:''}

fileUrl：必要，Office文档文件地址(string)

fileName：必要，Office文档文件名，带后缀(string)

uploadUrl：必要，上传地址(string)

uploadToken：可选，上传Token(string)
json

  • 当文件后缀名不是Word、Excel或PowerPoint文档格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当文件名长度超过限制（32位Office最多支持255个字节）时，返回
    {"status":"error","data":{"message":"文件名长度超过255个字节"}}

  • 当Microsoft Office与Kingsoft Office均未安装时，返回
    {"status":"error","data":{"message":""Microsoft Office与Kingsoft Office均未安装"}}

  • 当从文件地址下载文件失败时，返回
    {"status":"error","data":{"message":"下载文件失败"}}

  • 当用户点击取消，取消操作时，返回
    {"status":"error","data":{"message":"操作已取消"}}

  • 当并未编辑Office文档时，返回
    {"status":"success","data":{"message":"文件未修改"}}

  • 当编辑之后的Office文档文件上传失败时，返回
    {"status":"error","data":{"message":"上传文件失败"}}

  • 当编辑之后的Office文档文件上传成功时，返回
    {"status":"success","data":{"url":"","fileSize":""}}
    url：上传之后的Office文档文件地址
    fileSize：编辑之后的Office文档文件大小

fileupload 文件上传

action

fileupload
param

{filePath : '',uploadUrl : '',uploadToken : ''}

filePath：必要，上传文件路径(string)，一般由openfiledialog接口返回

uploadUrl：必要，上传地址(string)

uploadToken：可选，上传Token(string)
json

  • 当文件上传失败时，返回
    {"status":"error","data":{_服务器返回错误_}}

  • 当文件上传成功时，返回
    {"status":"success","data":{_服务器返回成功_}}

audioconvertupload 音频转码上传

action

audioconvertupload
param

{filePath : '',uploadUrl : '',uploadToken : ''}

filePath：必要，上传文件路径(string)，一般由openfiledialog接口返回

uploadUrl：必要，上传地址(string)

uploadToken：可选，上传Token(string)
json

  • 当选择的音频文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是Video格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当用户点击取消，取消转码上传时，返回
    {"status":"error","data":{"message":"操作已取消"}}

  • 当转码后的音频文件上传失败时，返回
    {"status":"error","data":{"message":"上传文件失败"}}

  • 当转码后的音频文件上传成功时，返回
    {"status":"success","data":{"url":"","fileSize":""}}
    url：音频文件播放地址
    fileSize：转码后的音频文件大小

videoconvertupload 视频转码上传

action

videoconvertupload
param

{filePath : '',uploadUrl : '',uploadToken : ''}

filePath：必要，上传文件路径(string)，一般由openfiledialog接口返回

uploadUrl：必要，上传地址(string)

uploadToken：可选，上传Token(string)
json

  • 当选择的视频文件已经打开时，返回
    {"status":"error","data":{"message":"_文件路径_文件已打开"}}

  • 当文件路径后缀名不是Audio格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当用户点击取消，取消转码上传时，返回
    {"status":"error","data":{"message":"操作已取消"}}

  • 当转码后的视频文件上传失败时，返回
    {"status":"error","data":{"message":"上传文件失败"}}

  • 当转码后的视频文件上传成功时，返回
    {"status":"success","data":{"url":"","fileSize":""}}
    url：视频文件播放的m3u8文件地址，类似于.../default.m3u8
    fileSize：转码后的视频文件大小

testpapermake 调用阅卷系统-答题卡生成

action

testpapermake
param

{apiPath : '',fileUploadPath : '',downloadPath : '',schoolToken : '',schoolCode : '',actionCode : '',testId : '',json : '',mode : ''}

apiPath：必要，apiPath(string)

fileUploadPath：必要，fileUploadPath(string)

downloadPath：必要，downloadPath(string)

schoolToken：必要，schoolToken(string)

schoolCode：必要，schoolCode(string)

actionCode：必要，actionCode(string)

testId：必要，testId(string)

json：必要，json，可为json文件路径或json文件内容(string)

mode：必要，mode(string)

xml：可选，xml，可为xml文件路径或xml文件内容(string)
json

  • 当阅卷系统未安装时，返回
    {"status":"error","data":{"message":"K12ScorePaper应用程序未安装"}}

  • 当传入的json为文件路径，且该路径不存在时，返回
    {"status":"error","data":{"message":"传入的json文件不存在"}}

  • 当传入的xml为文件路径，且该路径不存在时，返回
    {"status":"error","data":{"message":"传入的xml文件不存在"}}

  • 当阅卷系统调用完毕时，返回
    {"status":"success","data":{"message":"操作已完成"}}

testpaperscore 调用阅卷系统-统考阅卷

action

testpaperscore
param

{apiPath : '',fileUploadPath : '',downloadPath : '',schoolToken : '',schoolCode : '',actionCode : '',testId : ''}

apiPath：必要，apiPath(string)

fileUploadPath：必要，fileUploadPath(string)

downloadPath：必要，downloadPath(string)

schoolToken：必要，schoolToken(string)

schoolCode：必要，schoolCode(string)

actionCode：必要，actionCode(string)

testId：必要，testId(string)
json

  • 当阅卷系统未安装时，返回
    {"status":"error","data":{"message":"K12ScorePaper应用程序未安装"}}

  • 当阅卷系统调用完毕时，返回
    {"status":"success","data":{"message":"操作已完成"}}

testexport 导出考试文件

action

testexport
param

{filePath : '',jsonFileUrl : '',xmlFileUrl : ''}

filePath：必要，导出test文件的路径(string)，一般由savefiledialog接口返回

jsonFileUrl：必要，考试内容结构json文件地址(string)

xmlFileUrl：必要，考试答题卡xml文件地址(string)
json

  • 当下载json或xml文件失败时，返回
    {"status":"error","data":{"message":"下载文件失败"}}

  • 当文件路径后缀名不是Test格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当导出test成功时，返回
    {"status":"success","data":{"message":"文件已保存到_文件路径_"}}

testimport 导入考试文件

action

testimport
param

{filePath : ''}

filePath：必要，要导入的test文件路径(string)，一般由openfiledialog接口返回
json

  • 当文件路径后缀名不是Test格式时，返回
    {"status":"error","data":{"message":"文件格式错误"}}

  • 当解压test文件失败时，返回
    {"status":"error","data":{"message":"处理文件失败"}}

  • 当成功解压test文件时，返回
    {"status":"success","data":{"jsonFilePath":"","xmlFilePath":"","json":""}}
    jsonFilePath：本地考试内容结构json文件路径
    xmlFilePath：本地考试答题卡xml文件路径
    json：本地考试内容结构json文件的文件内容

接口示例