需适配的 API 汇总

WARNING

请注意,当前域名 https://dev.weixin.qq.com/docs/framework 文档已不维护,请前往微信文档中心open in new window 找到对应的新文档继续使用

  • 多端框架是基于与小程序同源的技术实现,大部分的小程序 JSAPI 在多端应用中均可使用,但的确有部分的 API 因为产品载体已经变成为 App,无法再支持的,开发者需对这部分的 API 进行兼容性处理
  • 为方便开发者对 API 进行兼容处理,本文将需开发者适配处理的 API 进行汇总,如对相关的内容有疑问,可联系小助手open in new window进行反馈处理

对于不支持的 API,通常可分为 3 种情况:

  • 部分是有新的 API 进行替换或者是原有的 API 在参数上进行了一些调整:开发者使用条件编译语法进行兼容处理即可
  • 部分 API 是尚未支持:是官方有计划支持或者已经在开发中,届时上线后,开发者使用条件编译语法进行兼容处理即可
  • 部分 API 无法在 App 中支持:此种情况需开发者提前了解,需寻求其他替换方案或者在 App 中不提供相关功能

一、需开发者进行适配兼容的接口

  • 下方功能需使用新的 API 进行实现
名称功能说明需使用新 API
wx.login小程序登录• 关于在 App 中实现登录的功能,平台提供了多种方案,涉及多个 API
• 详情可查看微信登录说明open in new window 以及小程序登录适配方案说明open in new window
wx.showShareXXX转发(微信分享相关功能)• 在 App 中使用微信分享(分享图片、分享文本、分享网页、分享小程序等)功能,需使用新的 wx.miniapp.shareXXXX 接口实现,详情可查看转发open in new window
-App 拉起小程序• 在 App 中拉起小程序需要使用新接口,详情可查看wx.miniapp.launchMiniProgramopen in new window
wx.requestPayment微信支付• 需使用新接口 wx.miniapp.requestPaymentopen in new window
• 部分 iOS 场景中,需使用苹果内购 IAP(In-App Purchase),详情可查看 wx.miniapp.IAPopen in new window
wx.openCustomerServiceChat打开微信客服• 需使用新接口 wx.miniapp.openCustomerServiceChatopen in new window
wx.requestSubscribeMessage订阅消息• 小程序订阅消息能力在 App 中无法使用;
• App 中支持一次性订阅消息接口 wx.miniapp.requestSubscribeMessageopen in new window
• App 的消息推送功能开发中,即将支持
wx.getSystemInfo获取系统信息• 该接口的返回参数有所调整,详情可查看open in new window
• wx.getSystemInfoSync 的参数返回处理同 wx.getSystemInfo
wx.getAppBaseInfo获取 App 基础信息• 该接口的返回参数有所调整,详情可查看wx.getAppBaseInfoopen in new window
wx.getLaunchOptionsSync获取本次应用启动时的参数• 该接口的返回参数有所调整,详情可查看wx.getLaunchOptionsSyncopen in new window
wx.getEnterOptionsSync获取应用启动时的参数• 该接口的返回参数有所调整,详情可查看wx.getEnterOptionsSyncopen in new window
wx.getMenuButtonBoundingClientRect获取菜单按钮(右上角胶囊按钮)的布局位置信息• App里不再呈现胶囊标识,该接口依旧返回相关坐标信息,便于开发者进行多端兼容
• 需该接口当前的返回不满足需求,可联系小助手open in new window进行反馈
wx.getBackgroundAudioManager获取全局唯一的背景音频管理器• 该接口是在小程序提供的同名 API 上拓展的,详情可查看wx.getBackgroundAudioManageropen in new window

二、尚未支持的接口