getGroupInfo - 获取 group 信息

getGroupInfo(params: Object)

版本要求:

DeviceKit≥2.3.1@ray-js/ray≥0.6.23

支持平台:

iOSAndroid

import { device } from '@ray-js/ray';

const { getGroupInfo } = device;

// Promise 调用
try {
  const res = await getGroupInfo({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

获取 group 信息

参数

属性	类型	必填	说明
`groupId`	string	是	群组id
`complete`	() => void	否	接口调用结束的回调函数（调用成功、失败都会执行）
`success`	(params: Object) => void	否	接口调用成功的回调函数
`fail`	(params: Object) => void	否	接口调用失败的回调函数

success 回调参数

属性	类型	说明	DeviceKit 最低版本
`groupId`	string	groupId The group ID.	v3.3.0
`productId`	string	productId The product ID.	v3.3.0
`name`	string	name The name of the group.	v3.3.0
`time`	number	time The time when the group was created.	v3.3.0
`iconUrl`	string	iconUrl The URL of the icon.	v3.3.0
`type`	number	type The type of group. Wifi = 0, Mesh = 1, Zigbee = 2, SIGMesh = 3, Beacon = 4,	v3.3.0
`isShare`	boolean	是否为分享群组，true 表示当前用户为被分享方	v3.3.0
		群组功能点状态，key 为 dpId，value 为对应的状态值	v3.3.0
		群组标准功能集 code，key 为 dpCode，value 为对应状态值	v3.3.0
`deviceNum`	number	deviceNum The number of devices,	v3.3.0
`localKey`	string	localKey The local key.	v3.3.0
`pv`	number	The protocol version.	v3.3.0
		The product information.	v3.3.0
		The custom DP name.	v3.3.0
		The device list.	v3.3.0
`localId`	string	The local short address of groups.	v3.3.0
`pcc`	string	The subclass.	v3.3.0
`meshId`	string	The mesh ID or gateway ID.	v3.3.0
`groupKey`	string	Add the beacon beaconKey.	v3.3.0
		The schema array.	v3.3.0

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

示例代码

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

device.getGroupInfo({
  groupId: "xx",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});