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 further docs 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