listMemberBadges( )

Lists the badges assigned to each of the specified site members.

Description

The listMemberBadges() function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.

Note: This function replaces the deprecated wix-users-backend.badges.listMemberBadges(). The deprecated function will continue to work, but it will not receive updates. To keep any existing code compatible with future changes, see the migration instructions.

Syntax

function listMemberBadges(memberIds: Array<string>): Promise<Array<MemberBadges>>

listMemberBadges Parameters

NAME

TYPE

DESCRIPTION

memberIds

Array<string>

List of member IDs to list badges for.

Returns

Fulfilled - Array of objects, each containing a member ID and associated badge IDs. Rejected - Error message.

Return Type:

Promise<Array<MemberBadges>>

NAME

TYPE

DESCRIPTION

memberId

string

Member ID.

badgeIds

Array<string>

List of badge IDs assigned to the member.

Was this helpful?

List badges assigned to members

Copy Code

1import { badges } from 'wix-members-backend';
2
3export function myListMemberBadgesFunction() {
4  const memberIds = [
5    "32cf071a-cc2f-450f-ad74-5a25db0b1b6a",
6    "2cb1846f-0c7a-4c39-8736-349236cfab40",
7    "69nh659a-ic2f-950f-ed74-14a25db9b1b6j"
8  ];
9
10  return badges.listMemberBadges(memberIds)
11    .then((memberBadges) => {
12      const firstMemberBadges = memberBadges[0].badgeIds;
13      return memberBadges;
14    })
15    .catch((error) => {
16      console.error(error);
17    });
18}
19
20/*
21 * Promise resolves to:
22 * [
23 *   {
24 *     "memberId": "32cf071a-cc2f-450f-ad74-5a25db0b1b6a",
25 *     "badgeIds": [
26 *       "0d37ea22-44b0-4a62-9818-ff660178c439",
27 *       "c7d1a81d-485a-4eef-872f-4595ab2a15a2"
28 *     ]
29 *   },
30 *   {
31 *     "memberId": "2cb1846f-0c7a-4c39-8736-349236cfab40",
32 *     "badgeIds": [
33 *       "0d37ea22-44b0-4a62-9818-ff660178c439",
34 *       "41dcda59-8b6d-4deb-bb1f-d283de044b85",
35 *       "df9fc0e2-c2ba-40ba-a160-200a016c3507"
36 *     ]
37 *   },
38 *   {
39 *     "memberId": "69nh659a-ic2f-950f-ed74-14a25db9b1b6j",
40 *     "badgeIds": [
41 *       "df9fc0e2-c2ba-40ba-a160-200a016c3507"
42 *     ]
43 *   }
44 * ]
45 */