---
name: "getProductInfo"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "1.2.6" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getProductInfo - 获取产品信息"
---

## getProductInfo

> [VERSION] DeviceKit >= 1.2.6 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

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

### 描述

获取产品信息

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `productId` | `string` | 是 | - | `1.2.6` | 产品id |
| `productVer` | `string` | 否 | `"1.0.0"` | `4.3.6` | 产品版本号 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `panelConfig` | `Record<string, Record<string, any>>` | `3.3.0` | 面板配置项，可以在平台进行配置 |
| `schema` | `string` | `3.3.0` | 产品功能定义集合 |
| `schemaExt` | `string` | `3.3.0` | 产品功能定义集合拓展 |
| `capability` | `number` | `3.3.0` | capability 产品能力值，在 backend-ng 平台上可以查询对应的勾选项，整体业务逻辑会根据该数据进行划分 区分设备类型也可以根据该属性进行调整，按二进制位运算的方式进行管理 |
| `attribute` | `number` | `3.3.0` | attribute 产品属性定义，在 backend-ng 平台上可查到对应配置，使用二进制位运算的方式进行管理 |
| `productId` | `string` | `3.3.0` | productId 产品 id |
| `category` | `string` | `3.3.0` | category 产品的分类 |
| `categoryCode` | `string` | `3.3.0` | categoryCode 产品的二级分类 |
| `standard` | `boolean` | `3.3.0` | standard 是否为标准产品 |
| `pcc` | `string` | `3.3.0` | pcc Thing自研蓝牙 mesh 产品的分类标识 |
| `vendorInfo` | `string` | `3.3.0` | vendorInfo Thing自研蓝牙 mesh 产品的分类标识，融合类使用 |
| `quickOpDps` | `string[]` | `3.3.0` | quickOpDps 快捷操作的 dp ids |
| `faultDps` | `string[]` | `3.3.0` | faultDps 告警/错误的显示 dp ids |
| `displayDps` | `string[]` | `3.3.0` | displayDps 快捷操作的 dp ids |
| `displayMsgs` | `Record<string, Record<string, any>>` | `3.3.0` | displayMsgs 快捷操作显示文案 |
| `uiPhase` | `string` | `3.3.0` | uiPhase ui 包当前环境，预览包或线上包 |
| `uiId` | `string` | `3.3.0` | uiId ui 包唯一包名识别 |
| `uiVersion` | `string` | `3.3.0` | uiVersion ui 包版本号 |
| `ui` | `string` | `3.3.0` | ui ui 小标识 |
| `rnFind` | `boolean` | `3.3.0` | rnFind 是否有包含 RN 包 |
| `uiType` | `string` | `3.3.0` | uiType ui 包类型 |
| `uiName` | `string` | `3.3.0` | uiName ui 包名称 |
| `i18nTime` | `number` | `3.3.0` | i18nTime 产品语言包最新更新时间 |
| `supportGroup` | `boolean` | `3.3.0` | supportGroup 是否支持创建群组 |
| `supportSGroup` | `boolean` | `3.3.0` | supportSGroup 是否支持创建标准群组 |
| `configMetas` | `Record<string, Record<string, any>>` | `3.3.0` | configMetas 产品特殊配置项，一些功能业务的特殊配置 |
| `productVer` | `string` | `3.3.0` | productVer 产品版本 |
| `attributeString` | `string` | `4.0.0` | attribute 格式化的二进制字符串 产品属性定义，在 backend-ng 平台上可查到对应配置，使用二进制位运算的方式进行管理 |

#### fail 回调参数

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

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

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


### 示例代码

#### 基础调用

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

const { getProductInfo } = device;

getProductInfo({
  productId: 'example',
  success: (result) => {
    console.log('getProductInfo success', result);
  },
  fail: (error) => {
    console.log('getProductInfo fail', error.errorMsg);
  },
});
```