app面板拉取JSON配置信息
getUiConfig
引入
使用该功能需要
@ray-js/ray版本 1.6.6 及以上。
import { getUiConfig } from '@ray-js/ray'参数
GetUiConfigParams
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| productId | string | 是 | 产品id |
返回
GetUiConfigResponse
| 属性 | 类型 | 说明 |
|---|---|---|
| cloudDp | CloudDP | 设备云端数据点配置 |
| uiContent | PowerCode | UI 内容配置 |
| powerCode | object | 云能力code |
CloudDP
| 属性 | 类型 | 说明 |
|---|---|---|
| subUiId | string | 子 uiId |
| cloud | { jump_url: JumpUrl; timer: Timer } | 包含 jump_url 和 timer 的配置 |
**JumpUrl **
| 属性 | 类型 | 说明 |
|---|---|---|
| code | string | 功能代码 |
| name | string | 功能名称 |
| selected | boolean | 是否选中 |
| description | string | 功能描述 |
**Timer **
| 属性 | 类型 | 说明 |
|---|---|---|
| code | string | 功能代码 |
| name | string | 功能名称 |
| selected | boolean | 是否选中 |
| description | string | 功能描述 |
PowerCode
| 属性 | 类型 | 说明 |
|---|---|---|
| themeImage | ThemeImage | 主题图片设置 |
| cloud | Record | 云端配置，键值对格式 |
| timestamp | string | 时间戳 |
| dps | Record | dp点信息，键值对格式 |
| themeColor | ThemeColor | 主题颜色设置 |
| theme | string | 主题类型（如 "light" 或 "dark"） |
ThemeImage
| 属性 | 类型 | 说明 |
|---|---|---|
| type | string | 图片类型 |
| rangeType | string | 范围类型 |
| value | Value | 图片的初始化值 |
**ThemeColor **
| 属性 | 类型 | 说明 |
|---|---|---|
| type | string | 颜色类型 |
| rangeType | string | 范围类型 |
| value | Value | 颜色的初始化值 |
函数定义示例
/**
* app面板拉取JSON配置信息
*/
export function getUiConfig(params: GetUiConfigParams): Promise<GetUiConfigResponse>获取产品纬度蓝牙通信协议高级能力配置
getHighPowerList
引入
使用该功能需要
@ray-js/ray版本 1.6.6 及以上。
import { getHighPowerList } from '@ray-js/ray'参数
GetHighPowerListParams
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
devId | string | 是 | 设备id |
返回
GetUiConfigResponse
| 属性 | 类型 | 说明 |
|---|---|---|
| code | string | 高级能力code |
| extConfig | string | 免费时对应返回值 |
| isBuy | boolean | 是否可以在C端购买购买 |
| isEnable | boolean | 是否可以使用 |
| serviceOrder | ServiceOrder | C端购买的返回对象 |
| status | number | 可用的二级状态 0:免费 1:历史打标设备 2:C端增值服务购买 |
| tagValue | string | 历史打标的返回值 |
| uuid | string | 设备的uuid |
ServiceOrder 类型定义
ServiceOrder 描述了具体的服务订单信息。
| 属性 | 类型 | 说明 |
|---|---|---|
| categoryCode | string | 分类code |
| categoryId | number | 分类id |
| cid | string | 用户id |
| commodityCode | string | 商品码 |
| customCommodityCode | string | 客户商品码 |
| duration | number | 服务时长，已换算为天 |
| ext | string | 扩展字段，存储额外信息如 |
| groupId | number | 家庭id |
| ownerId | string | 为哪个对象买的服务 uuid/家庭ID |
| ownerType | number | 对象类型：0=设备，1=家庭 |
| serviceBeginTime | number | 服务开始时间 |
| serviceEndTime | number | 服务结束时间 |
| serviceOrderStatus | number | 服务状态: 0=created, 1=running, 2=expired, 3=released｜ |
| serviceOrderType | number | 服务单类型 0:普通单，1:免费单 |
| serviceTypeCode | string | 服务类型码 |
函数定义示例
/**
* 获取产品纬度蓝牙通信协议高级能力配置
*/
export function getHighPowerList(params: GetHighPowerListParams): Promise<GetHighPowerListResponse>获取国家名称
getCountryList
引入
使用该功能需要
@ray-js/ray版本 1.6.6 及以上。
import { getCountryList } from '@ray-js/ray';参数
GetCountryListParams
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| lang | string | 是 | 语种 |
返回
GetCountryListResponse
Record<string, any>，表示国家名称。
函数定义示例
/**
* 获取国家名称
*/
export function getCountryList(params: GetCountryListParams): Promise<GetCountryListResponse>;获取当前帐号所属地区
getUserRegion
引入
使用该功能需要
@ray-js/ray版本 1.6.6 及以上。
import { getUserRegion } from '@ray-js/ray';返回
GetUserRegionResult
表示当前帐号所属地区结果。
| 属性 | 类型 | 说明 |
|---|---|---|
| region | string | 地区 |
函数定义示例
/**
* 获取当前帐号所属地区
*/
export function getUserRegion(): Promise<GetUserRegionResult>;此页内容是否对您有帮助？
是
意见反馈