引入JS
调用前需要在您的h5页面中 引入H5桥接js文件。
在H5中引入js文件。
示例代码
    
        <script src="https://pjax.cc/doc/app.api.js"> <script>
    
浏览DEOMO
您可以参照DOMO来进行开发与测试 查看DEMO
ms.getLocation(Object object)
调用前需要 用户授权使用地理位置,并且确认用户已开启 GPS服务
获取当前的地理位置坐标、速度、海拔高度、详细地址等信息。
示例代码
    
        ms.getLocation({
            success : function(p){
                alert(JSON.stringify(p) );
                var latitude = p.coords.latitude ;
                var longitude = p.coords.longitude ;
                var altitude =  p.coords.altitude ;
                alert('Geolocation\nLatitude:' + latitude + '\nLongitude:' + longitude + '\nAltitude:' + altitude);
            },
            fail : function(err){
                alert("获取地理位置失败:"+ JSON.stringify(err) );
            }
        });
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(Object res)
属性
类型
说明
最低版本
coords.latitude
number
纬度,范围为 -90~90,负数表示南纬
coords.longitude
number
经度,范围为 -180~180,负数表示西经
coords.altitude
number
海拔高度,如果无法获取此信息,则此值为空(null)。
coords.accuracy
number
地理坐标信息的精确度信息
coords.altitudeAccuracy
number
海拔的精确度信息,单位为米,其有效值大于0。
coords.heading
number
设备移动的方向,范围为0到360,表示相对于正北方向的角度。
coords.speed
number
设备移动的速度,单位为米每秒(m/s),其有效值必须大于0。
address
String
详细地址信息,包括country、province、city、district、street、streetNum、cityCode等信息
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误代码,1:访问权限被拒绝;2:位置信息不可用;3:获取位置信息超时;4:未知错误。
message
String
错误描述信息
ms.scanCode(Object object)
通过相机、相册两种方式,识别二维码图片,返回文本内容。
示例代码
    
        ms.scanCode({
            style : {
                background : '#000', //扫码控件背景色
                frameColor : '#07c160', //扫码控件边框颜色
                scanbarColor : '#07c160' , //扫码控件扫描条颜色
                top:'100px', //距离顶部的位置
                left:'0px', //距离左侧的位置
                width: '100%', //宽度
                height: '500px' //高度
            },
            success : function(code){
                alert("扫码识别文本:" + code);
            },
            fail : function(err){
                alert("扫码失败:"+ JSON.stringify(err) );
            }
        });
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
style
object
绿色主题
扫码控件的位置、大小、颜色等个性化样式
Android - 2.2+ ,iOS - 4.3+
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(String code)
属性
类型
说明
最低版本
code
String
识别到的二维码文本数据,采用UTF8编码格式。
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
ms.closeBarcode()
调用前需 已开启扫码控件
关闭扫码控件,用于主动取消扫码。
示例代码
    
        ms.closeBarcode();
    
ms.scanFromGallery(Object object)
从相册选取二维码图片后扫码,返回扫码识别文本内容。
示例代码
    
        ms.scanFromGallery({
            success : function(code){
                alert("相册扫码识别文本:" + code);
            },
            fail : function(err){
                alert("相册扫码失败:"+ JSON.stringify(err) );
            }
        });
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(String code)
属性
类型
说明
最低版本
code
String
识别到的二维码文本数据,采用UTF8编码格式。
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
ms.getContacts(Object object)
调用前需要 用户授权使用通讯录。注意:无法获取SIM卡通讯录信息
获取用户手机通讯录中的联系人信息列表。
示例代码
    
        ms.getContacts({
            success : function(contacts){
                alert(JSON.stringify(contacts) );
            },
            fail : function(err){
                alert("获取通讯录失败:"+ JSON.stringify(err) );
            }
        });

    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(Array array.object)
属性
类型
说明
最低版本
id
String
联系人的id
displayName
String
联系人显示的名字
Android - 2.2+ (支持): 如果name(ContactName)的givenName未设置,则会保存到givenName值中。iOS - 5.1+ (支持)。
name
String
联系人的名称
nickname
String
联系人的昵称
phoneNumbers
Array
数组,联系人的电话列表,如果联系人中未保存电话信息,则返回空数组。
emails
Array
数组,联系人的邮箱,如果联系人中未保存邮箱信息,则返回空数组。
addresses
Array
数组,联系人的地址
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
UploadTask ms.uploadFile(Object object)
将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data。
示例代码
    
          var uploadTask = ms.uploadFile({
            url : 'https://xxxx.yourdomain.com/api/saveFile' ,
            filePath : downloadFilePath ,
            name : 'upfile' ,
            mimeType : "image/png" , //指定上传文件的类型,不指定会读取文件名的后缀,可能会导致上传文件无法读取的错误。
            options : {
                method : "POST" , //仅支持“POST”请求。
                blocksize : 102400 , //上传任务每次上传的文件块大小(仅在支持断点续传的服务有效),若设置值小于等于0则表示不分块上传。
                priority : 100 , //数值越大优先级越高,默认优先级值为100。
                timeout : 120 , // 超时时间为服务器响应请求的时间(不是上传任务完成的总时间),如果设置为0则表示永远不超时。
                retry : 3 , //上传任务重试次数
                retryInterval : 30 //上传任务重试间隔时间
            },
            formData : {
                type : '测试类型'  //自定义的附加数据
            },
            header : {
                customer : "customerValuexxxxx" //不支持设置“Content-Type”、“User-Agent”、“Cookie”的值。
            },
            onProgress : function(uploadSize , totalSize , percent){
                //已上传文件大小,文件总大小,上传百分比
                console.log("上传进度:" + uploadSize + "/" + totalSize + ",已上传:" + percent );
            },
            success : function(res){
                alert(JSON.stringify(res));
            },
            fail : function(err){
                alert(JSON.stringify(err));
            }
        });


        setTimeout(function(){
            uploadTask.abort(); //取消未完成上传任务
        },4000);

    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
url
String
上传服务器地址
Android - 2.2+ ,iOS - 5.1+
filePath
String
本地文件路径
name
String
上传服务器端接收上传文件的key
mimeType
String
上传文件的类型(如图片文件为“image/jpeg”),默认值自动根据文件后缀名称生成。
options.blocksize
number
上传任务每次上传的文件块大小(仅在支持断点续传的服务有效),若设置值小于等于0则表示不分块上传。
options.priority
number
100
上传任务的优先级,数值越大优先级越高。
options.timeout
number
120
上传任务超时时间,单位为s(秒),如果设置为0则表示永远不超时。
options.retry
number
3
上传任务重试次数
options.retryInterval
number
30
上传任务重试间隔时间,单位为s(秒)。
formData
JSON
自定义上传附带数据
header
JSON
HTTP 请求 Header,Header 中不支持设置“Content-Type”、“User-Agent”、“Cookie”的值。
onProgress
function
上传进度监听函数
success
function
接口调用成功的回调函数
fail
function
接口调用失败的回调函数
object.onProgress 回调函数参数(String uploadSize , String totalSize , String percent)
属性
类型
说明
最低版本
uploadSize
String
已上传文件大小
totalSize
String
文件总大小
percent
number
已上传百分比
object.success 回调函数参数(Object res)
属性
类型
说明
最低版本
res
JSON/String
服务器响应参数,可转为JSON时,返回JSON对象,否则为String。
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
DownloadTask ms.downloadFile(Object object)
下载网络文件至本地目录,获得本地文件地址。
示例代码
    
        var downloadTask = ms.downloadFile({
            url : 'https://xxxx.com/download/xxxxx.zip' , //文件的网络链接
            onProgress : function(downloadSize , totalSize , percent){
                //已下载文件大小,文件总大小,下载百分比
                console.log("下载进度:" + downloadSize + "/" + totalSize );
                console.log("下载进度百分比:" + percent );
            },
            success : function(path){
                alert( "文件下载成功,本地路径为:\n" + path );
            },
            fail : function(err){
                alert("文件下载失败:"+ JSON.stringify(err) );
            }
        });

        setTimeout(function(){
            downloadTask.abort(); //取消未完成下载任务
        },4000);

    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
onProgress
function
下载进度监听函数
Android - 2.2+ ,iOS - 4.3+
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.onProgress 回调函数参数(String downloadSize , String totalSize , String percent)
属性
类型
说明
最低版本
downloadSize
String
已下载文件大小
totalSize
String
文件总大小
percent
number
已下载百分比
object.success 回调函数参数(String path)
属性
类型
说明
最低版本
path
String
下载文件的本地路径
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
ms.readTxtFile(Object object)
获取本地文件的文本内容,支持utf-8编码。
示例代码
    
        ms.readTxtFile({
            filePath : '_doc/xxxxx.txt' , //仅支持本地文件路径
            success : function(res){
                alert("文件大小:\n" + res.size + "\n文件路径:\n" + res.name + "\n文件内容:\n" + res.content );
            },
            fail : function(err){
                alert("文件读取失败:"+ JSON.stringify(err) );
            }
        });

    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
filePath
String
要读取的本地文件的路径
Android - 2.2+ ,iOS - 4.3+
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(Object res)
属性
类型
说明
最低版本
size
number
文本数据的大小
name
String
文件的名称
content
String
文本内容
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
ms.setStorage(String key , String value)
将任意数据写入本地存储,无数据大小限制。建议单个键值对数据总量在10KB以内,否则会影响性能。
示例代码
    
        ms.setStorage( 'name' , '小明');
    
参数
String key , String value
属性
类型
默认值
必填
说明
最低版本
key
String
键名
Android - 2.2+ ,iOS - 4.3+
value
Any
键值,支持String、Array、json等任意数据类型。
Android - 2.2+ ,iOS - 4.3+
ms.getStorage(String key)
读取已经写入本地存储的数据。
示例代码
    
        var localName = ms.getStorage( 'name' );
    
参数
String key
属性
类型
默认值
必填
说明
最低版本
key
String
键名
Android - 2.2+ ,iOS - 4.3+
ms.wxShare(Object object)
将网页分享到微信好友、群或朋友圈。
示例代码
    
        ms.wxShare({
                title: "接口可以自定义的标题",//标题
                content: "接口可以自定义的分享描述,也可以自定义链接,自定义缩略图哦~",
                href: 'https://www.baidu.com/' ,//分享出去后,点击跳转地址
                imgUrl: "https://www.baidu.com/img/superlogo_c4d7df0a003d3db9b65e9ef0fe6da1ec.png?where=super" , //分享缩略图
                success : function(e){
                    alert("分享完成,无法判断是否分享成功哦~");
                },
            fail : function(err){
                alert(JSON.stringify(err));
            }
        });
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
title
String
分享标题
Android - 2.2+ ,iOS - 4.3+
content
String
分享描述信息
Android - 2.2+ ,iOS - 4.3+
href
String
分享网址的跳转链接
Android - 2.2+ ,iOS - 4.3+
imgUrl
String
分享缩略图
Android - 2.2+ ,iOS - 4.3+
success
function
接口调用成功的回调函数
Android - 2.2+ ,iOS - 4.3+
fail
function
接口调用失败的回调函数
Android - 2.2+ ,iOS - 4.3+
object.success 回调函数参数(Object object)
属性
类型
说明
最低版本
code
number
分享完成,无法判断是否分享成功。
message
String
分享完成描述信息
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误编码
message
String
错误描述信息
ms.wxPay(Object object)
调用微信APP支付。
示例代码
    
        //请求微信预付订单信息
        sendGetRequest(
            "https://xxxxx.com/wxPay" ,
            function(res){

                ms.wxPay({
                    statement : res , //服务端返回的支付订单参数
                    success : function(res){
                        alert(JSON.stringify(res));
                    },
                    fail : function(err){
                        alert(JSON.stringify(err));
                    }
                });

            }
        );
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
statement
JSON
调用微信支付所必须的请求参数,由服务端返回。
Android - 2.2+ ,iOS - 5.0+
success
function
接口调用成功的回调函数
fail
function
接口调用失败的回调函数
object.success 回调函数参数(Object res)
属性
类型
说明
最低版本
res
Object
微信支付成功返回的原始数据
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误代码, -1,一般错误; -2,用户取消; -3,发送失败; -4,认证被否决; -5,不支持错误。
message
String
错误描述信息
ms.alipay(Object object)
调用支付宝APP支付。
示例代码
    
        //请求微信预付订单信息
        sendGetRequest(
            "https://xxxxx.com/alipay" ,
            function(res){

                ms.alipay({
                    statement : res , //服务端返回的支付订单参数
                    success : function(res){
                        alert(JSON.stringify(res));
                    },
                    fail : function(err){
                        alert(JSON.stringify(err));
                    }
                });

            }
        );
    
参数
Object object
属性
类型
默认值
必填
说明
最低版本
statement
JSON
调用支付宝支付所必须的请求参数,由服务端返回。
Android - 2.2+ ,iOS - 5.0+
success
function
接口调用成功的回调函数
fail
function
接口调用失败的回调函数
object.success 回调函数参数(Object res)
属性
类型
说明
最低版本
res
Object
支付宝支付成功返回的原始数据
object.fail 回调函数参数(Object res)
属性
类型
说明
最低版本
code
number
错误代码, 62000,客户端未安装支付通道依赖的服务; 62001,用户取消支付操作; 62002,此设备不支持支付; 62003,数据格式错误; 62004,支付账号状态错误; 62005,订单信息错误; 62006,支付操作内部错误; 62007,支付服务器错误; 62008,网络问题引起的错误; 62009,其它未定义的错误。
message
String
错误描述信息