Class ESPRMGroup

Represents a user group in the system, responsible for managing group-related information and associated nodes.

The ESPRMGroup class holds details about the group such as its name, ID, associated nodes, subgroups, and additional properties like metadata and custom data.

Implements

ESPRMGroupInterface

Constructors

constructor

new ESPRMGroup(config: ESPRMGroupInterface): ESPRMGroup
Creates an instance of ESPRMGroup with the specified configuration.
Parameters
- config: ESPRMGroupInterface
  The configuration object containing the properties to initialize the group.
Returns ESPRMGroup
- Defined in src/ESPRMGroup.ts:97

Properties

`Optional`customData

customData?: Record<string, any>

Custom data associated with the group.

`Optional`description

description?: string

A description of the group.

`Optional`fabricId

fabricId?: string

The fabric ID associated with the group.

id

id: string

The unique identifier of the group.

`Optional`isMatter

isMatter?: boolean

Indicates whether the group is a Matter-enabled group.

`Optional`isPrimaryUser

isPrimaryUser?: boolean

Indicates whether the group is a primary user group.

`Optional`metadata

metadata?: Record<string, any>

Additional metadata associated with the group.

`Optional`mutuallyExclusive

mutuallyExclusive?: boolean

Indicates whether the group has mutually exclusive users.

name

name: string

The name of the group.

`Optional`nodeDetails

nodeDetails?: ESPRMNode[]

A list of ESPRMNode instances representing the nodes in the group.

`Optional`nodes

nodes?: string[]

A list of node IDs associated with the group.

`Optional`parentGroupId

parentGroupId?: string

The ID of the parent group.

`Optional`subGroups

subGroups?: ESPRMGroup[]

A list of subgroups within this group.

`Optional`totalNodes

totalNodes?: number

The total number of nodes in the group.

`Optional`type

type?: string

The type of the group (e.g., "admin", "user").

Methods

addNodes

addNodes(nodeList: string[]): Promise<ESPAPIResponse>
Adds a list of nodes to the current group.
Parameters
- nodeList: string[]
  The list of node IDs to add to the group.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.

Throws
If the nodeList is empty.
- Defined in src/methods/ESPRMGroup/AddNodes.ts:30

createSubGroup

createSubGroup(groupInfo: CreateSubGroupRequest): Promise<ESPRMGroup>
Creates a sub-group under the current group.
Parameters
- groupInfo: CreateSubGroupRequest
  The details of the sub-group to be created.
Returns Promise<ESPRMGroup>
A promise that resolves to the created sub-group as an ESPRMGroup instance.
- Defined in src/methods/ESPRMGroup/CreateSubGroup.ts:23

delete

delete(): Promise<ESPAPIResponse>
Deletes the current group.

Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMGroup/Delete.ts:22

getNodesList

getNodesList(): Promise<string[]>
Retrieves the list of node IDs associated with the group.

Returns Promise<string[]>
A promise that resolves to an array of node IDs.
- Defined in src/methods/ESPRMGroup/GetNodesList.ts:20

getNodesWithDetails

getNodesWithDetails(): Promise<ESPRMNode[]>
Retrieves a list of nodes with detailed information.

Returns Promise<ESPRMNode[]>
A promise that resolves to an array of ESPRMNode instances with detailed data.
- Defined in src/methods/ESPRMGroup/GetNodesWithDetails.ts:22

getSharingInfo

getSharingInfo(
getSharingInfoRequestParams: GetSharingInfoRequest,
): Promise<ESPGroupSharingInfo>
Parameters
- getSharingInfoRequestParams: GetSharingInfoRequest
Returns Promise<ESPGroupSharingInfo>
- Defined in src/methods/ESPRMGroup/GetSharingInfo.ts:24

getSubGroups

getSubGroups(): Promise<ESPRMGroup[]>
Retrieves the list of sub-groups for the current group.

Returns Promise<ESPRMGroup[]>
A promise that resolves to an array of ESPRMGroup instances representing the sub-groups.
- Defined in src/methods/ESPRMGroup/GetSubGroups.ts:21

leave

leave(): Promise<ESPAPIResponse>
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.

Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMGroup/Leave.ts:25

removeNodes

removeNodes(nodeList: string[]): Promise<ESPAPIResponse>
Removes a list of nodes from the current group.
Parameters
- nodeList: string[]
  The list of node IDs to remove from the group.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.

Throws
If the nodeList is empty.
- Defined in src/methods/ESPRMGroup/RemoveNodes.ts:30

removeSharingFor

removeSharingFor(username: string): Promise<ESPAPIResponse>
Removes sharing permissions for a specified user in the current group.
Parameters
- username: string
  The username of the user for whom sharing permissions will be removed.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMGroup/RemoveSharingFor.ts:23

Share(shareGroupRequestParams: ShareGroupRequest): Promise<string>
Shares the specified groups with a user.
Parameters
- shareGroupRequestParams: ShareGroupRequest
  The parameters needed for sharing groups.
Returns Promise<string>
A promise that resolves to the request ID from the API.
- Defined in src/methods/ESPRMGroup/Share.ts:23

transfer

transfer(transferGroupsRequestParams: TransferGroupRequest): Promise<string>
Transfers the specified groups to another user.
Parameters
- transferGroupsRequestParams: TransferGroupRequest
  The parameters needed for transferring groups.
Returns Promise<string>
A promise that resolves to the request ID from the API.
- Defined in src/methods/ESPRMGroup/Transfer.ts:23

updateGroupInfo

updateGroupInfo(updateInfo: UpdateGroupInfoRequest): Promise<ESPAPIResponse>
Updates the information of the current group.
Parameters
- updateInfo: UpdateGroupInfoRequest
  The new information for the group.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMGroup/UpdateGroupInfo.ts:30

updateMetadata

updateMetadata(metadata: Record<string, any>): Promise<ESPAPIResponse>
Updates the metadata of the current group.
Parameters
- metadata: Record<string, any>
  The new metadata to set for the group.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMGroup/UpdateMetadata.ts:23

Class ESPRMGroup

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ESPRMGroup

Properties

OptionalcustomData

Optionaldescription

OptionalfabricId

id

OptionalisMatter

OptionalisPrimaryUser

Optionalmetadata

OptionalmutuallyExclusive

name

OptionalnodeDetails

Optionalnodes

OptionalparentGroupId

OptionalsubGroups

OptionaltotalNodes

Optionaltype

Methods

addNodes

Parameters

Returns Promise<ESPAPIResponse>

Throws

createSubGroup

Parameters

Returns Promise<ESPRMGroup>

delete

Returns Promise<ESPAPIResponse>

getNodesList

Returns Promise<string[]>

getNodesWithDetails

Returns Promise<ESPRMNode[]>

getSharingInfo

Parameters

Returns Promise<ESPGroupSharingInfo>

getSubGroups

Returns Promise<ESPRMGroup[]>

leave

Returns Promise<ESPAPIResponse>

removeNodes

Parameters

Returns Promise<ESPAPIResponse>

Throws

removeSharingFor

Parameters

Returns Promise<ESPAPIResponse>

Share

Parameters

Returns Promise<string>

transfer

Parameters

Returns Promise<string>

updateGroupInfo

Parameters

Returns Promise<ESPAPIResponse>

updateMetadata

Parameters

Returns Promise<ESPAPIResponse>

Settings

On This Page

`Optional`customData

`Optional`description

`Optional`fabricId

`Optional`isMatter

`Optional`isPrimaryUser

`Optional`metadata

`Optional`mutuallyExclusive

`Optional`nodeDetails

`Optional`nodes

`Optional`parentGroupId

`Optional`subGroups

`Optional`totalNodes

`Optional`type