---
name: "getSetting"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.12.0" }
  - { name: "@ray-js/ray", version: "1.5.30" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getSetting - Get user's current settings. Return value only contains permissions that the mini app has requested from the user"
---

## getSetting

> [VERSION] BaseKit >= 3.12.0 | @ray-js/ray >= 1.5.30

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Get the user's current settings. The response includes only the permissions the miniapp has previously requested.

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `authSetting` | `Record<string, boolean>` | `3.12.0` | User authorization result |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

```tsx
import { getSetting } from '@ray-js/ray'

getSetting({
  success: data => {
    console.log(data.authSetting);
  },
  fail: error => {
    console.error(error);
  },
});
```