title: Taro.getSetting(option)

sidebar_label: getSetting

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

支持情况：getSetting - 图1 getSetting - 图2 getSetting - 图3 getSetting - 图4

参考文档

类型

  1. (option?: Option) => Promise<SuccessCallbackResult>

参数

参数 类型
option Option

Option

参数 类型 必填 说明
withSubscriptions boolean 否 是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。
complete (res: TaroGeneral.CallbackResult) => void 否 接口调用结束的回调函数（调用成功、失败都会执行）
fail (res: TaroGeneral.CallbackResult) => void 否 接口调用失败的回调函数
success (result: SuccessCallbackResult) => void 否 接口调用成功的回调函数

SuccessCallbackResult

参数 类型 说明
authSetting AuthSetting 用户授权结果
subscriptionsSetting SubscriptionsSetting 用户订阅消息设置，接口参数 withSubscriptions 值为 true 时才会返回。
miniprogramAuthSetting AuthSetting 在插件中调用时，当前宿主小程序的用户授权结果
errMsg string 调用结果

示例代码

  1. Taro.getSetting({
  2.   success: function (res) {
  3.     console.log(res.authSetting)
  4.     // res.authSetting = {
  5.     //   "scope.userInfo": true,
  6.     //   "scope.userLocation": true
  7.     // }
  8.   }
  9. })