基础功能API

基础功能API指小程序容器内封装的基础功能模块向JS层提供的API接口,包括页面切换、数据存储、动画效果、网络、多媒体等。

公共API模块分为weex原生提供的api功能模块和银商添加的安卓功能模块。

说明

Weex 提供的原有的公共 API 模块,有一些安卓兼容性和功能 Bug,本文所提供的模块虽然与 Weex 原有的公共 API 同名,但实际功能上也有一定差异。

基础API调用规则

小程序开发者使用 Vue.js 语法调用基础功能 API 有以下两个步骤:

  1. 声明需要调用的模块
var moduleName = weex.requireModule('<模块名>');

其中,变量名 moduleName 可任意指定,推荐使用驼峰命名法。对于银商添加定制的模块,模块名称格式通常为:’ums/模块名’,例如:

var mediaAudio = weex.requireModule('ums/media/audio')
  1. 调用模块内API

完成声明操作后,开发者可使用定义的变量来调用具体的模块方法:

moduleName.funcApi(options, callback);      //options为API参数列表,callback为回调函数
  • 调用实例:

以页面切换功能模块为例,模块名为:navigator

从当前页面切换到另一个页面的调用方式如下:

var navigator = weex.requireModule('navigator');
navigator.push({
	url: 'dist/otherPage.js',
	animated: "true"
	}, event => {
	modal.toast({
		message: 'callback: ' + event
	})
})