Assigns a badge to site members.
The assignMembers()
function returns a Promise
that resolves when the specified badge is assigned to the specified members.
The badgeId
parameter must be an ID from your site's Members/Badges
collection.
Typically, you retrieve the ID from the collection using a query or through a dataset.
function assignMembers(
badgeId: string,
memberIds: Array<string>,
): Promise<Array<string>>;
ID of the badge to assign the members to.
IDs of the members to assign to the badge.
import { Permissions, webMethod } from "wix-web-module";
import { badges } from "wix-members-backend";
export const myAssignMembersFunction = webMethod(Permissions.Anyone, () => {
const badgeId = "3fcaacc0-a3a7-464f-9ba9-f211bdcec9fc";
const memberIds = [
"efab296e-2687-4751-9956-ee73200dd4bb",
"3403e13b-8826-4af6-aa19-18784bb84a8e",
"28d35f86-6694-4455-9dff-aff5d450b482",
];
return badges
.assignMembers(badgeId, memberIds)
.then((assignedMembers) => {
return assignedMembers;
})
.catch((error) => {
console.error(error);
});
});
/* Promise resolves to:
* {
* "memberIds": [
* "efab296e-2687-4751-9956-ee73200dd4bb",
* "3403e13b-8826-4af6-aa19-18784bb84a8e",
* "28d35f86-6694-4455-9dff-aff5d450b482"
* ]
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.