---
name: "getDeviceInfo"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.4.3" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getDeviceInfo

> [VERSION] BaseKit >= 2.4.3

> [PLATFORM] iOS, Android

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

### Description

Get basic device information

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Completion callback (runs on success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Success callback function |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback function |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `abi` | `string` | `3.2.6` | Application binary interface type (Android only) |
| `brand` | `string` | `3.2.6` | Device brand |
| `model` | `string` | `3.2.6` | Device model. Newly released models may show "unknown" for a period of time. |
| `system` | `string` | `3.2.6` | Operating system and version |
| `platform` | `string` | `3.2.6` | System type, e.g., iOS, Android, Harmony |
| `uuid` | `string` | `3.35.5` | Unique device ID |

#### 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 information |


### Examples

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