# SDK 介绍

# 一、基本信息

# 1.1 iOS SDK

# 1.2 Android SDK

# 二、使用介绍

  • 为了保证 SDK 的安全稳定性以及控制 SDK 体积,将 SDK 拆分为基础 SDK 与扩展 SDK,后者是前者的补充,因此使用扩展 SDK 也必须依赖基础 SDK。
  • 而扩展 SDK 开发者可以按需在微信开发者工具的project.miniapp.json中进行配置,即扩展 SDK 为可选项。

# 2.1 基础 SDK

  • 基础 SDK 中集成了丰富的 API 与相关组件,用来保障最基础的应用的正常运行,如下组件或者 JSAPI 在基础 SDK 中已经包含,即开发者在微信开发者工具的project.miniapp.json只需要配置对应的对应的 SDK 版本即可
  • 基础 SDK 收集设备型号及操作系统版本信息,用于解决在不同设备、不同操作系统下SDK产品的兼容性问题

  • 如果开发者的业务逻辑中调用了例如日历、联系人等涉及用户个人信息的 JSAPI,应当在隐私政策中进行声明(点此可查看个人信息监控范围

# 2.1.1 基础 SDK 已经包含的 JSAPI 如下:

JSAPI 分组名称 接口详情
「基础」相关API 「API 总览 - 基础」
「系统」相关API 「API 总览 - 系统」
「生命周期」相关API 「API 总览 - 生命周期」
「应用级事件」相关API 「API 总览 - 应用级事件」
「调试」相关API 「API 总览 - 调试」
「性能」相关API 「API 总览 - 性能」
「路由」相关API 「API 总览 - 路由」
「EventChannel」相关API 「API 总览 - EventChannel」
「界面」相关API 「API 总览 - 界面」
「导航栏」相关API 「API 总览 - 导航栏」
「Tab Bar」相关API 「API 总览 - Tab Bar」
「字体」相关API 「API 总览 - 字体」
「滚动」相关API 「API 总览 - 滚动」
「动画」相关API 「API 总览 - 动画」
「置顶」相关API 「API 总览 - 置顶」
「自定义组件」相关API 「API 总览 - 自定义组件」
「菜单」相关API 「API 总览 - 菜单」
「发起请求」相关API 「API 总览 - 网络 - 发起请求」
「下载」相关API 「API 总览 - 网络 - 下载」
「上传」相关API 「API 总览 - 网络 - 上传」
「进入多端App」相关API 「API 总览 - 监听进入多端App」
「数据缓存」相关API 「API 总览 - 数据缓存」
「画布」相关API(iOS) 「API 总览 - 画布」
「富文本」相关API 「API 总览 - 媒体 - 富文本」
「文件」相关API 「API 总览 - 文件」
「日历」相关API 「API 总览 - 日历」
「联系人」相关API 「API 总览 - 联系人」
「电量」相关API 「API 总览 - 电量」
「剪贴板」相关API 「API 总览 - 剪贴板」
「加密」相关API 「API 总览 - 加密」
「屏幕」相关API 「API 总览 - 屏幕」
「键盘」相关API 「API 总览 - 键盘」
「电话」相关API(Android) 「API 总览 - 电话」
「加速计」相关API(Android) 「API 总览 - 加速计」
「罗盘」相关API(Android) 「API 总览 - 罗盘」
「设备方向」相关API(Android) 「API 总览 - 设备方向」
「陀螺仪」相关API(Android) 「API 总览 - 陀螺仪」
「振动」相关API(Android) 「API 总览 - 振动」
「短信」相关API(Android) 「API 总览 - 短信」
「Worker」相关API 「API 总览 - Worker」
「WXML」相关API 「API 总览 - WXML」

# 2.2 扩展 SDK

  • 多端应用框架中部分小程序 JSAPI 抽离成了单独的模块以减少应用打包体积,用户可根据自身需要引入所需功能。开发者可以在开发者工具通过可视化编辑项目的 project.miniapp.json 中 拓展 SDK 配置来设置对应的拓展模块是否使用

  • 部分截图如下,详情可查看扩展SDK

  • 部分扩展 SDK 涉及收集了个人信息,如果你的应用使用了涉及收集个人信息的 JSAPI,开发者需在应用的隐私政策中详细说明,否则会被应用市场驳回;上架相关问题可以查看上架应用市场常见问题

  • 补充:点此可查看个人信息监控范围

  • 注意:开启配置以后需要重新构建App。

# 2.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.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
补充:点此查看腾讯广告合规指南

# 三、SDK 更新日志