开发文档

概述

API

框架提供给开发者更多的JSAPI和OpenAPI能力,通过小程序可以为用户提供多样化便捷服务。

说明:

my.on 开头的 API 用来监听系统事件,接受一个 callback 函数作为参数。当该事件触发时,会调用 callback 函数,该 callback 函数可以传给对应 my.off 开头的 API 来解除监听关系,如果直接调用my.off 开头的 API 则为解除所有监听关系。例如

Page({
  onLoad() {
    this.callback = this.callback.bind(this);
    my.onBLECharacteristicValueChange(this.callback);
  },
  onUnload() {
    // 页面卸载时解除监听
    my.offBLECharacteristicValueChange(this.callback);
  },
  callback(res) {
    console.log(res);
  },
});

其他 API 接口都接受一个 object 作为参数。可以指定success(调用成功), fail(调用失败), complete(调用成功或失败)来接收接口调用结果。回调结果如无特殊说明,一般为一个对象,其中如果有 error/errorMessage 则表示调用失败。调用后返回值为一个 promise 对象。 例如

my.httpRequest({
  url: '/x.htm',
  success:(res1) => {
  },
}).then((res2) => {
  // res1 === res2
},(res2) => {
  console.log(res.error, res.errorMessage);
})