---
name: "authorize"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## authorize

> [VERSION] BaseKit >= 2.0.1 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

权限请求方法

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `scope` | `"scope.bluetooth" \| "scope.record" \| "scope.writePhotosAlbum" \| "scope.camera" \| "scope.userLocation" \| "scope.userPreciseLocation" \| "scope.userLocationBackground" \| "scope.userInfo" \| "scope.calendar" \| "scope.nearByWifiDevice"` | 否 | `'scope.writePhotosAlbum'` | `2.0.1` | scope 权限名称 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 合法值

##### `scope` 合法值

| 值 | 说明 |
| --- | --- |
| `"scope.bluetooth"` | 蓝牙权限 |
| `"scope.record"` | 麦克风权限 |
| `"scope.writePhotosAlbum"` | 写入权限 |
| `"scope.camera"` | 摄像头权限 |
| `"scope.userLocation"` | 低精度定位权限 |
| `"scope.userPreciseLocation"` | 高精度定位权限 |
| `"scope.userLocationBackground"` | 后台定位权限
注意: iOS需要将TARGETS->Capabilities->Background Modes->Location updates打开 |
| `"scope.userInfo"` | 用户信息 |
| `"scope.calendar"` | 日历读写权限 |
| `"scope.nearByWifiDevice"` | 连接附近Wifi设备，安卓特有 |


### 示例代码

#### Demo

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

authorize({
  scope: "scope.writePhotosAlbum",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```