---
name: "getUserInfo"
mode: "kit"
versionRequirements:
  - { name: "BizKit", version: "3.0.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getUserInfo

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

> [PLATFORM] iOS, Android

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

### Description

Get user information

### 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 |
| --- | --- | --- | --- |
| `nickName` | `string` | `3.1.2` | nickName User nickname |
| `avatarUrl` | `string` | `3.1.2` | User avatar |
| `phoneCode` | `string` | `3.1.2` | Phone number country/region code Example: 86 |
| `regionCode` | `string` | `4.12.13` | Server region code for the user; see RegionCode Example: AY |
| `isTemporaryUser` | `boolean` | `3.1.2` | Whether temporary user |
| `timezoneId` | `string` | `4.12.13` | User time zone ID Example: Asia/Shanghai |
| `regFrom` | `number` | `4.12.13` | Account registration method (ThingRegType) |
| `tempUnit` | `number` | `4.12.13` | User temperature unit; see TempUnit: 1 for Celsius (°C), 2 for Fahrenheit (°F) Example: 1 |

#### 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 { getUserInfo } from '@ray-js/ray'

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