Creates an instance of ESPRMGroup with the specified configuration.
The configuration object containing the properties to initialize the group.
OptionalcustomCustom data associated with the group.
OptionaldescriptionA description of the group.
OptionalfabricThe fabric ID associated with the group.
The unique identifier of the group.
OptionalisIndicates whether the group is a Matter-enabled group.
OptionalisIndicates whether the group is a primary user group.
OptionalmetadataAdditional metadata associated with the group.
OptionalmutuallyIndicates whether the group has mutually exclusive users.
The name of the group.
OptionalnodeA list of ESPRMNode instances representing the nodes in the group.
OptionalnodesA list of node IDs associated with the group.
OptionalparentThe ID of the parent group.
OptionalsubA list of subgroups within this group.
OptionaltotalThe total number of nodes in the group.
OptionaltypeThe type of the group (e.g., "admin", "user").
Adds a list of nodes to the current group.
The list of node IDs to add to the group.
A promise that resolves to the API success response.
Creates a sub-group under the current group.
The details of the sub-group to be created.
A promise that resolves to the created sub-group as an ESPRMGroup instance.
Deletes the current group.
A promise that resolves to the API success response.
Retrieves the list of node IDs associated with the group.
A promise that resolves to an array of node IDs.
Retrieves a list of nodes with detailed information.
A promise that resolves to an array of ESPRMNode instances with detailed data.
Retrieves the list of sub-groups for the current group.
A promise that resolves to an array of ESPRMGroup instances representing the sub-groups.
Removes the user from the current group.
This method sends a DELETE request to the API to remove the user's association with the current group, effectively allowing the user to leave the group.
A promise that resolves to the API success response.
Removes a list of nodes from the current group.
The list of node IDs to remove from the group.
A promise that resolves to the API success response.
Removes sharing permissions for a specified user in the current group.
The username of the user for whom sharing permissions will be removed.
A promise that resolves to the API success response.
Shares the specified groups with a user.
The parameters needed for sharing groups.
A promise that resolves to the request ID from the API.
Transfers the specified groups to another user.
The parameters needed for transferring groups.
A promise that resolves to the request ID from the API.
Updates the information of the current group.
The new information for the group.
A promise that resolves to the API success response.
Updates the metadata of the current group.
The new metadata to set for the group.
A promise that resolves to the API success response.
Represents a user group in the system, responsible for managing group-related information and associated nodes.
The
ESPRMGroupclass holds details about the group such as its name, ID, associated nodes, subgroups, and additional properties like metadata and custom data.