# wx.getSetting(Object object)

> 基础库 1.2.0 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：支持
> 
> __小程序插件__：支持，需要小程序基础库版本不低于 [2.6.3](1003706)
> 
>   在小程序插件中使用时，接口有以下不同：
> 
>   - `withSubscriptions` 无效（插件暂无订阅消息）
> 
>   - 返回值中的 `authSetting` 字段中是插件的权限（如用户信息功能页授权）
> 
>   - [2.14.0](1003706) 起返回值中有 `miniprogramAuthSetting` 字段，内容等于当前小程序 `getSetting` 的结果（不含订阅状态）
> 
> __微信 Windows 版__：支持
> 
> __微信 Mac 版__：支持
> 
> __微信 鸿蒙 OS 版__：支持

> 相关文档: [授权](/miniprogram/dev/framework/open-ability/authorize.md)、[接口调用频率规范](/miniprogram/dev/framework/performance/api-frequency.md)

## 功能描述

获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](/miniprogram/dev/framework/open-ability/authorize.md)**。

## 参数

### Object object

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

#### object.success 回调函数
##### 参数

###### Object res

| 属性 | 类型 | 说明 | 最低版本 |
| ---- | ---- | ---- | -------- |
| authSetting  | [AuthSetting](/miniprogram/dev/api/open-api/setting/AuthSetting) | 用户授权结果 |  |
| subscriptionsSetting  | [SubscriptionsSetting](/miniprogram/dev/api/open-api/setting/SubscriptionsSetting) | 用户订阅消息设置，接口参数`withSubscriptions`值为`true`时才会返回。 | [2.10.1](1003706) |
| miniprogramAuthSetting  | [AuthSetting](/miniprogram/dev/api/open-api/setting/AuthSetting) | 在插件中调用时，当前宿主小程序的用户授权结果 |  |

## 示例代码

```js
wx.getSetting({
  success (res) {
    console.log(res.authSetting)
    // res.authSetting = {
    //   "scope.userInfo": true,
    //   "scope.userLocation": true
    // }
  }
})
```

```js
wx.getSetting({
  withSubscriptions: true,
  success (res) {
    console.log(res.authSetting)
    // res.authSetting = {
    //   "scope.userInfo": true,
    //   "scope.userLocation": true
    // }
    console.log(res.subscriptionsSetting)
    // res.subscriptionsSetting = {
    //   mainSwitch: true, // 订阅消息总开关
    //   itemSettings: {   // 每一项开关
    //     SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
    //     SYS_MSG_TYPE_RANK: 'accept'
    //     zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
    //     ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
    //   }
    // }
  }
})
```