wx.getSetting(Object object)

基础库 1.2.0 开始支持，低版本需做兼容处理。

本接口从基础库版本 2.6.3 起支持在小程序插件中使用

获取用户的当前设置。返回值中只会出现小程序已经向用户请求过的权限。

在小程序插件中使用时，接口有以下不同：

  • withSubscriptions 无效（插件暂无订阅消息）
  • 返回值中的 authSetting 字段中是插件的权限（如用户信息功能页授权）
  • 2.14.0 起返回值中有 miniprogramAuthSetting 字段，内容等于当前小程序 getSetting 的结果（不含订阅状态）

参数

Object object

属性类型默认值必填说明最低版本
withSubscriptionsBooleanfalse否是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。2.10.1
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性类型说明最低版本
authSettingAuthSetting用户授权结果
subscriptionsSettingSubscriptionsSetting用户订阅消息设置，接口参数withSubscriptions值为true时才会返回。2.10.1
miniprogramAuthSettingAuthSetting在插件中调用时，当前宿主小程序的用户授权结果

示例代码

  1. wx.getSetting({
  2.   success (res) {
  3.     console.log(res.authSetting)
  4.     // res.authSetting = {
  5.     //   "scope.userInfo": true,
  6.     //   "scope.userLocation": true
  7.     // }
  8.   }
  9. })
  1. wx.getSetting({
  2.   withSubscriptions: true,
  3.   success (res) {
  4.     console.log(res.authSetting)
  5.     // res.authSetting = {
  6.     //   "scope.userInfo": true,
  7.     //   "scope.userLocation": true
  8.     // }
  9.     console.log(res.subscriptionsSetting)
  10.     // res.subscriptionsSetting = {
  11.     //   mainSwitch: true, // 订阅消息总开关
  12.     //   itemSettings: {   // 每一项开关
  13.     //     SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
  14.     //     SYS_MSG_TYPE_RANK: 'accept'
  15.     //     zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
  16.     //     ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
  17.     //   }
  18.     // }
  19.   }
  20. })