Skip to main content

Overview

The @espressif/rainmaker-base-sdk provides functionality to manage node groups, instances of ESPRMGroup, within the application. This includes retrieving a list of node groups, creating node groups and subgroups, removing and adding nodes to the node group, sharing groups, and managing group metadata.

Note: The userInstance used in the documentation refers to ESPRMUser class instance obtained in User Sign in step.

Group Management in RainMaker​

Group management in RainMaker enables you to:

  • Create and manage node groups
  • Add and remove nodes from groups
  • Create subgroups within groups
  • Share groups with other users
  • Transfer group ownership
  • Update group information and metadata
  • Manage group sharing requests

Group Management Sections​

Get Groups​

Retrieve and query node groups.

  • Get user groups (with pagination)
  • Get group by ID
  • Get group by name

Manage Groups​

Create, update, and manage node groups.

  • Create node group
  • Update group info
  • Delete group
  • Leave group
  • Add nodes to group
  • Remove nodes from group
  • Get nodes list
  • Get nodes with details
  • Create subgroup
  • Get subgroups

Share Groups​

Share groups with other users and manage sharing requests.

  • Share groups
  • Transfer groups
  • Share group (group-level)
  • Transfer group (group-level)
  • Remove sharing for
  • Get sharing info
  • Get issued group sharing requests
  • Get received group sharing requests

Group Metadata​

Manage group metadata and custom data.

  • Update metadata

On this page