Groups
Users can be added to groups to participate in a simulation.
Groups in the JS libraries correspond to workshops in the Epicenter UI.
Read this guide to learn how to use the Group adapter to manage groups and their members.
Operations on groups and members
The same functions of the Group adapter can be used to manage both groups and individual group members.
By default, the functions make calls to the /group API endpoints. To manage group members, you need to call the /group/member endpoints. To modify the API URL, use the function's augment parameter, which takes a value of the Augment enum.
Adding members to a group
To allow users to self-register for the group, set the group's allowSelfRegistration property to true. If this property is false, a user must be invited to the group by a facilitator.
To establish a deadline for group registration, set the group's expirationDate property.
To limit the number of times the group members can participate in a simulation, set the runLimit property.
To enable users to receive push notifications about the simulation, set the group's allowChannel property.
To add users to a group, use the addUser() function.
For more details on managing group members, read the Group adapter reference.
Group status
To enable the facilitators to monitor the progress of a group during a simulation, you can set a status code and message for the group with the statusUpdate() function.