---
name: "getUserInfo"
mode: "kit"
versionRequirements:
  - { name: "BizKit", version: "3.0.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getUserInfo - 获取用户信息"
---

## getUserInfo

> [VERSION] BizKit >= 3.0.0 | @ray-js/ray >= 0.5.9

> [PLATFORM] iOS, Android

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

### 描述

获取用户信息

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `nickName` | `string` | `3.1.2` | nickName 用户昵称 |
| `avatarUrl` | `string` | `3.1.2` | 用户头像 |
| `phoneCode` | `string` | `3.1.2` | 手机号国家/地区区号 示例：86 |
| `regionCode` | `string` | `4.12.13` | 用户所在服务器区域编码，取值参考 RegionCode 示例：AY |
| `isTemporaryUser` | `boolean` | `3.1.2` | 是否是临时用户 |
| `timezoneId` | `string` | `4.12.13` | 用户时区 ID 示例：Asia/Shanghai |
| `regFrom` | `number` | `4.12.13` | 账号的注册方式 ThingRegType |
| `tempUnit` | `number` | `4.12.13` | 用户温度单位，取值参考 TempUnit：1 表示摄氏度（°C），2 表示华氏度（°F） 示例：1 |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

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