扩展 SDK
为缩减 SDK 的体积,基础 SDK 不包含部分扩展能力的 JSAPI,如开发者需使用对应的接口能力,需勾选对应的扩展 SDK
扩展 SDK 与 JSAPI 的对应关系可查看SDK 使用介绍 JSAPI 详情可查看 API 总览
一、使用介绍
多端应用框架中部分小程序 JSAPI 抽离成了单独的模块以减少应用打包体积,用户可根据自身需要引入所需功能。开发者可以在开发者工具通过可视化编辑项目的 project.miniapp.json
中 拓展 SDK 配置来设置对应的拓展模块是否使用,详情可查看 配置文件
部分扩展 SDK 涉及收集了个人信息,如果你的应用使用了涉及收集个人信息的 JSAPI,开发者需在应用的隐私政策中详细说明,否则会被应用市场驳回;上架相关问题可以查看上架应用市场常见问题
补充:点此可查看个人信息监控范围
注意:开启配置以后需要重新构建App。
二、扩展 SDK 及对应的 JSAPI
当前支持的扩展 SDK 如下(注意,Android 与 iOS 有所区别):
2.1 iOS 扩展 SDK
project.miniapp.json 中对应的名称 | JSAPI 分组名称 | 接口详情 |
---|---|---|
OpenFuns SDK(不含支付) | wx.miniapp.shareXXX 相关API以及 wx.miniapp.login | API 总览 - 转发 API 总览 - 登录 |
OpenFuns SDK(含支付) | wx.miniapp.shareXXX 相关API以及 wx.miniapp.login、wx.miniapp.requestPayment | API 总览 - 转发 API 总览 - 登录 API 总览 - 支付 |
Network SDK | WebSocket、mDNS、TCP 通信、UDP 通信、WIFI、网络相关API | API 总览 - 网络 - WebSocket API 总览 - 网络 - mDNS API 总览 - 网络 - TCP 通信 API 总览 - 网络 - UDP 通信 API 总览 - WIFI API 总览 - 网络 |
LBS SDK | 地图、位置相关API | API 总览 - 媒体 - 地图 API 总览 - 位置 |
Media SDK | 图片、视频、音频、背景音频、录音、相机相关API | API 总览 - 媒体 - 图片 API 总览 - 媒体 - 视频 API 总览 - 媒体 - 音频 API 总览 - 媒体 - 背景音频 API 总览 - 媒体 - 录音 API 总览 - 媒体 - 相机 |
Bluetooth SDK | 蓝牙API | API 总览 - 蓝牙 - 通用 API 总览 - 蓝牙 - 低功耗中心设备 API 总览 - 蓝牙 - 低功耗外围设备 API 总览 - 蓝牙 - 信标(Beacon) |
Idaas SDK | 苹果登录相关API | wx.appleLogin |
TPNS SDK | 消息推送相关API | wx.miniapp.getXGPushManager 补充:点此查看消息推送合规指南 |
GDT SDK | 腾讯广告相关API | wx.miniapp.setEnableAdSplash 补充:点此查看腾讯广告合规指南 |
Others SDK | 电话、扫码、短信相关API | API 总览 - 电话 API 总览 - 扫码 API 总览 - 短信 |
LBS SDK | 加速计、罗盘、设备方向、陀螺仪相关API | API 总览 - 加速计 API 总览 - 罗盘 API 总览 - 陀螺仪 API 总览 - 设备方向 |
2.2 Android 扩展 SDK
project.miniapp.json 中对应的名称 | JSAPI 分组名称 | 接口详情 |
---|---|---|
Network SDK | WebSocket、mDNS、TCP 通信、UDP 通信、WIFI、网络相关API | API 总览 - 网络 - WebSocket API 总览 - 网络 - mDNS API 总览 - 网络 - TCP 通信 API 总览 - 网络 - UDP 通信 API 总览 - WIFI API 总览 - 网络 |
LBS SDK | 地图、位置相关API | API 总览 - 媒体 - 地图 API 总览 - 位置 |
Media SDK | 图片、视频、音频、背景音频、录音、相机相关API | API 总览 - 媒体 - 图片 API 总览 - 媒体 - 视频 API 总览 - 媒体 - 音频 API 总览 - 媒体 - 背景音频 API 总览 - 媒体 - 录音 API 总览 - 媒体 - 相机 |
Bluetooth SDK | 蓝牙API | API 总览 - 蓝牙 - 通用 API 总览 - 蓝牙 - 低功耗中心设备 API 总览 - 蓝牙 - 低功耗外围设备 API 总览 - 蓝牙 - 信标(Beacon) |
Scanner SDK | 扫码相关API | API 总览 - 扫码 |
XWEB SDK | 画布 canvas相关API | API 总览 - 画布 |
XWEB Embed SDK | 画布 canvas相关API | API 总览 - 画布 |
TPNS SDK | 消息推送相关API | wx.miniapp.getXGPushManager 补充:点此查看消息推送合规指南 |
GDT SDK | 腾讯广告相关API | wx.miniapp.setEnableAdSplash 补充:点此查看腾讯广告合规指南 |
三、补充说明
3.1 openSDK
关于微信登录、微信分享、微信支付等开放能力,Android 无需额外配置扩展 SDK;iOS 则需配置 OpenFuns SDK,且区分是否包含微信支付功能的版本;若你的应用使用了微信开放能力但无支付相关功能,需勾选 OpenFuns SDK(不含支付)的版本,否则在上架 App stroe 时会被驳回
OpenFuns SDK(不含支付)和 OpenFuns SDK(含支付) 不可同时勾选
3.2 扫码
如果使用了扫码的功能,ios 应用需勾选 Others SDK
3.3 XWEB
如果使用了 canvas、echart 等功能,Android 应用需勾选 XWeb SDK;且建议勾选 XWeb Embed SDK ,此版本 SDK 可在首次启动时即可加载,使得首次启动时即可正常使用 canvas、echart 等功能
补充:xweb 支持在真机使用,支持在 arm64 模拟器使用,不支持在 x86 模拟器或其他模拟器使用
XWeb SDK 和 XWeb Embed SDK 无需同时勾选,如果同时勾选效果等同于只勾选 XWeb Embed SDK
3.4 苹果支付
苹果支付相关接口,无需勾选相关的扩展 SDK ,按照接口文档接入即可