基础能力

JavaScript SDK 主要包含以下基础能力 API：

分类	API	说明
环境配置	initRequest	初始化请求环境
请求云函数	request	基础请求 API
	fetch	业务请求 API
	onFetchError	监听云函数错误统计处理事件
	offFetchError	注销云函数错误统计处理事件
打开页面	openDistribution	打开配网页面

环境配置

初始化请求环境

initRequest

配置初始化请求环境。

入参

入参为一个对象，对象支持的参数有：

名称	类型	必填	说明
schema	String	否	涂鸦开发者平台微信小程序项目的 schema

返回数据

无

示例

import { initRequest } from '@ray-js/wechat';

initRequest({ schema: 'xxxxx'});

请求云函数

基础请求 API

request

用于请求云函数。对于一般的业务云函数请求，请使用业务请求 API fetch。

入参

入参为一个对象，对象支持的配置有：

名称	类型	必填	说明
action	String	是	云函数名称
params	Object	否	云函数的参数
header	Object	否	云函数请求头

返回数据

返回云函数对应的数据。

示例

以获取国家码为例。

import { request } from '@ray-js/wechat';

Page({
    onLoad() {
           request({
              action: 'country.current',
           }).then(res => {
               this.setData({countries: res});
           });
     }
})

业务请求 API

fetch

当调用 loginByAccount、loginByWx 和 loginByTicket 等 API 后，可使用 fetch 来请求云函数，获取用户数据。

入参

入参为一个对象，对象支持的配置有：

名称	类型	必填	说明
action	String	是	云函数名称
params	Object	否	云函数的参数
header	Object	否	云函数请求头

返回数据

返回云函数对应的数据。

示例

以获取家庭消息 message.homeList 为例。

import { fetch } from '@ray-js/wechat';

Page({
    onLoad() {
           fetch({
              action: 'message.homeList',
               params: {
                time_zone_id: 'Asia/Shanghai',
                page_no: 1,
                page_size: 20,
            },
           }).then(res => {
               this.setData({messages: res.messages});
           });
     }
})

监听云函数错误统计处理事件

onFetchError

注册监听通过 fetch API 请求的云函数产生的错误事件，您可以通过此事件统一处理错误。可在全局作用域下注册此事件。

入参

func Function

一个监听回调函数，监听回调为一个错误对象，错误对象的数据结构为：

属性	说明
code	错误码
msg	错误描述

示例

import { onFetchError } from '@ray-js/wechat';

onFetchError((error) => {
    if (error.code === 60000) {
       console.log('登录超时，需要重新登录');
    }
});

注销云函数错误统计处理事件

offFetchError

注销监听通过 fetch API 请求的云函数产生的错误事件。

入参

func Function

一个监听回调函数，必须为 onFetchError 注册的回调函数。

示例

import { offFetchError, onFetchError } from '@ray-js/wechat';

Page({
handleError(error){
    if (error.code === 60000) {
         console.log('登录超时，需要重新登录');
     }
},
 onLoad(){
    onFetchError(this.handleError);
   },
    onUnload(){
    offFetchError(this.handleError);
   }
})

打开页面

打开配网页面

openDistribution

打开配网插件自发现页面。

入参

res Object

名称	类型	必填	说明
homeId	Number	是	需要配网的家庭
themeColor	String	否	主题色
pids	String[]	否	产品 ID（PID）