淘宝应用框架提供给开发者更多的 JSAPI 和 OpenAPI,使得开发者通过应用可为用户提供多样化便捷服务。
其中,JSAPI 大体分为两大类:事件监听型及功能型。调用demo下载
小程序JSAPI调用常见问题,如授权,网络请求my.httpRequest,my.uploadFile等接口的限制条件,点我了解详情
事件监听型 API 以 my.on
开头,用来监听系统事件。它们接受一个 callback 函数作为参数。当具体事件触发时,会触发 callback 函数调用。该 callback 函数可以传给对应以 my.off
开头的同名 API 来解除监听关系,如果直接调用以 my.off
开头的同名 API 则解除所有监听关系,例如:
Page({ onLoad() { this.callback = this.callback.bind(this); my.onNetworkStatusChange(this.callback); }, onUnload() { // 页面卸载时解除某个监听 my.offNetworkStatusChange(this.callback); // 或者解除所有监听 // my.offNetworkStatusChange(); }, callback(res) { console.log(res); }, });
功能型 API 是不以 my.on
或 my.off
开头的 API,用于实现某个特定功能。大多数 API 入参都为一个 Object 对象,并包含三个子参数:
名称 | 类型 | 必填 | 描述 |
success | Function | 否 | 调用成功的回调函数 |
fail | Function | 否 | 调用失败的回调函数 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行) |
回调结果若无特殊说明,一般为一个对象,其中若有 error 或 errorMessage 则表示调用失败,例如:
my.request({ url: 'https://httpbin.org/post', method: 'POST', data: { from: '千牛' }, dataType: 'json', success: function(res) { my.alert({content: 'success'}); }, fail: function(res) { my.alert({content: 'fail'}); }, complete: function(res) { my.alert({content: 'complete'}); } });
以上为通用说明,对某个特定 API 的入参及返回以其自身 API 说明为准。