DEV

开发文档

DEV

JS-SDK开发说明

1    JS接口调用使用说明

1.1   通过ready接口处理页面加载就需调用的js接口

must.ready(function(){
//所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
});

1.2   接口调用说明

所有接口通过must对象来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数:
success:接口调用成功时执行的回调函数。
error:接口调用失败时执行的回调函数。
complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。
 

2    JS接口

2.1   获取用户openId

2.1.1 被动获取openId
从MUST加载完网页页面后,会执行页面js中自定义的mustApiReady()方法。如果需要在页面加载时获取用户openId,或者调用相关的接口或者其他方法,网页开发人员需要在页面上自定义mustApiReady()方法,并把相关接口或者方法放在mustApiReady()函数中调用来确保正确执行。
2.1.2 主动获取openId
must.getOpenId({
    success: function (res) {
        var openId = res.openId; //获取openId
    }
});
 

2.2   获取地理位置

MUST加载完网页,网页开发人员可通过js调用此接口获取当前地理位置信息(经度、纬度),然后将经纬度落到地图上面显示出地址。
must.getLocation({
    success: function (res) {
        var latitude = res.latitude; // 纬度,浮点数,范围为90 ~ -90
        var longitude = res.longitude; // 经度,浮点数,范围为180 ~ -180
        var speed = res.speed; // 速度,以米/每秒计
        var accuracy = res.accuracy; // 位置精度
    }
});
 

2.3   隐藏右上角菜单

从MUST进入网页页面后,通过js调用此接口隐藏右上角菜单。
must.hideOptionMenu();
 

2.4   显示右上角菜单

must. showOptionMenu ();
 

2.5   关闭当前网页页面

从MUST加载完网页页面后,如果需要关闭当前页面返回到MUST使用其他功能,可通过js调用此接口关闭页面,返回到MUST进行操作。
must. closeWindow ();
 

2.6   隐藏页面底栏菜单

MUST打开网页页面后,底栏菜单可以复制链接、收藏、转发、刷新,如果页面开发时不需要使用MUST底栏菜单,可通过js调用此接口隐藏菜单。默认为隐藏。
must. hideBottomMenu ();
 

2.7   显示loading

从MUST打开网页页面后。可以通过showLoading接口来呼出Loading界面进行遮盖。
must.showLoading({
    message: “加载中,请稍后…”, // loading界面显示时的提示信息
    overtime:”2000”, //loading界面显示超时时间,单位ms,如果不传默认显示30s后自动隐藏
});
 

2.8   隐藏loading

隐藏当前已经显示的loading界面,一般在显示loading界面之后,待程序处理完后通过程序调用。
must.hideLoading();
 

2.9   从手机相册中选图或拍照

MUST加载网页页面后,网页开发如需使用现有手机相册的图片或使用摄像头拍下的相片,可调用此接口选择相册图片或摄像头拍摄的照片。
must.chooseImage({
    success: function (res) {
        var localIds = res.localIds; // 返回选定照片的本地ID列表,localId可以作为img标签的src属性显示图片
    }
});
 

2.10     手机录音功能

  1. 加载网页页面后,网页开发可使用此接口调用手机录音功能,将录制的声音上传到流媒体服务器并可进行播放。
开始录音:
must.startRecord();
停止录音:
must.stopRecord({
    success: function (res) {
        var localId = res.localId;
    }
});
播放语音:
must.playVoice({
    localId: '' // 需要播放的音频的地址,由stopRecord接口获得
});
暂停播放:
must.pauseVoice({
    localId: '' // 需要暂停的音频的地址,由stopRecord接口获得
});
停止播放:
must.stopVoice({
    localId: '' // 需要停止的音频的地址,由stopRecord接口获得
});
监听语音播放完毕:
must.onVoicePlayEnd({
    success: function (res) {
        var localId = res.localId; // 返回音频的地址
    }
});
上传语音:
must.uploadVoice({
    localId: '', // 需要上传的音频的本地地址,由stopRecord接口获得
    isShowProgressTips: 1, // 默认为1,显示进度提示
    success: function (res) {
        var serverId = res.serverId; // 返回音频的服务器端地址
    }
});
 
 

2.11     MUST扫一扫功能

MUST加载网页页面后,网页开发可使用此接口调用MUST扫一扫功能,将扫一扫获取到的信息交由MUST处理或返回给页面。
must.scanQRCode({
    needResult: 0, // 默认为0,扫描结果由MUST处理,1则直接返回扫描结果,
    scanType: ["qrCode","barCode"], //指定扫二维码还是一维码,默认二者都有
    success: function (res) {
        var result = res.resultStr; // needResult 1 时,扫码返回的结果
}
});
 

2.12     获取当前日期时间

MUST加载网页页面后,网页开发可使用此接口调用MUST选择日期界面,默认显示当前日期。
must.getDateTime({
    pattern: “yyyy-MM-dd”, // 日期格式(yyyy-MM-dd hh:mm
    success: function (res) {
        var result = res.data; //获取日期时间界面操作后返回的时间
}
});
 

2.13     获取指定日期时间

MUST加载网页页面后,网页开发可使用此接口调用MUST选择日期界面,日期选择界面为指定的日期。
must.getDateTime({
    pattern: “yyyy-MM-dd”, // 日期格式(yyyy-MM-dd hh:mm
    date: “2017-07-30”,//日期选择界面显示的指定日期
    success: function (res) {
        var result = res.data; //获取日期时间界面操作后返回的时间
}
});