Setup
To use the Roles API, install the @wix/groups
package using npm or Yarn:
1npm install @wix/groups
or
1yarn add @wix/groups
Then import { roles }
from @wix/groups
:
1import { roles } from '@wix/groups'
Assigns a specific role to group members.
Note: This function is only relevant for site admins, and group members with group admin permissions.
The assignRole()
function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
function assignRole(groupId: string, memberIds: Array<string>, role: GroupRole, options: AssignRoleOptions): Promise<AssignRoleResponse>
Group ID.
Member IDs.
Max: 100 member IDs
Role to assign.
Unassigns a role from group members.
Note: This function is only relevant for site admins, and group members with group admin permissions.
The unassignRole()
function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
function unassignRole(groupId: string, memberIds: Array<string>, role: GroupRole, options: UnassignRoleOptions): Promise<UnassignRoleResponse>
Group ID.
Member IDs.
Max: 100 member IDs
Role to unassign.