---
name: "getUserInfo"
mode: "kit"
versionRequirements:
  - { name: "BizKit", version: "3.0.0" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getUserInfo

> [VERSION] BizKit >= 3.0.0

> [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 | - | Complete callback (invoked on success or failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Success callback |
| `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 calling code Example: 86 |
| `regionCode` | `string` | `4.12.13` | User’s server region code; see RegionCode Example: AY |
| `isTemporaryUser` | `boolean` | `3.1.2` | Whether a 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 = Celsius (°C), 2 = 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` | Extended error code |
| `errorMsg` | `string` | Extended error message |


### Examples

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