---
name: "getCurrentUser"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getCurrentUser - 获取当前用户信息。"
summary: "获取当前用户信息。"
---

## getCurrentUser

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### 描述

获取当前用户

### 参数

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `isForce` | `boolean` | 否 | 是否强制刷新 |

### 返回值

类型: `Promise<CurrentUser>`

用户快照

##### CurrentUser

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `userId` | `string` | 云端用户 id |
| `lockUserId` | `number` | 锁内用户 id |
| `userType` | `10 \| 20 \| 30 \| 40 \| 50` | 用户类型（管理员/普通等） |
| `allOpenDps` | `string` | 支持远程开锁的 DP 集合编码串 |
| `allOpenType` | `number[]` | 支持的开锁方式类型 id 列表 |
| `productAttribute` | `number` | 产品属性位 |
| `phase` | `number` | 用户状态  0.冻结, 1. 正常 5. 已失效 6. 未生效 7. 已删除 |
| `admin` | `boolean` | 是否管理员 |
| `offlineUnlock` | `boolean` | 是否允许离线开锁 |
| `permanent` | `boolean` | 是否永久有效用户 |
| `expireTime` | `number` | 失效的时间(秒) |
| `effectiveTime` | `number` | 生效的时间(秒) |
| `expireDay` | `number` | 失效的绝对天数 |

### 示例代码

#### 示例

```ts
import { getCurrentUser } from '@ray-js/lock-sdk';
const user = await getCurrentUser();
```