Groups
Users must be added to a group to participate in a project and be able to log into your Epicenter app.
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 type.
Adding members to a group
Depending on your application requirements, you can have facilitators send invites to users or allow users to add themselves to groups by registering for workshops.
To add users to a group, use the Group adapter's addUser() function.
Self-registration
To implement the functionality that allows users to add themselves to a group, use the Registration adapter's self-registration functions.
To allow users to add themselves to the group, set the group's allowSelfRegistration property to true. You can also do this by configuring self-registration for the corresponding workshop in Epicenter.
Inviting members
To allow facilitators to invite new group members, use the Invite functions of the Registration adapter.
Group settings
To establish a deadline for group registration, set the group's expirationDate property.
To limit how many times 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 true.
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.