getGroupInfo – Tuya MiniApp

getGroupInfo(params: Object)

Requires:

DeviceKit≥2.3.1@ray-js/ray≥0.6.23

Platforms:

iOSAndroid

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

const { getGroupInfo } = device;

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

Description

Get group information

Parameters

Property	Type	Required	Description
`groupId`	string	Yes	Group ID
`complete`	() => void	No	Completion callback (executed on both success and failure)
`success`	(params: Object) => void	No	Callback on successful API call
`fail`	(params: Object) => void	No	Failure callback

success callback parameters

Property	Type	Description	DeviceKit Since
`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	Whether this is a shared group; true indicates the current user is the recipient of the share	v3.3.0
		Group datapoint status; keys are dpId and values are the corresponding status values	v3.3.0
		Group standard function set codes; keys are dpCode and values are the corresponding status values	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 callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Examples

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

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