Chuyển đến nội dung chính

Giới thiệu

Đọc các nhóm người dùng của dự án của bạn: danh sách phẳng, cấp cao nhất, một nhóm đơn lẻ, hoặc các nhóm con của một nhóm.

Thông tin thêm về giao diện người dùng của mô-đun https://doc.oneentry.cloud/docs/category/users


🎯 Mô-đun này làm gì?​

Mô-đun UserGroups cho phép bạn đọc các nhóm mà khách truy cập của bạn thuộc về. Một nhóm quyết định những gì một khách truy cập có thể thấy, và các nhóm tạo thành một cây — một nhóm có thể có một nhóm cha và các nhóm con.

Các nhóm được tạo và lồng vào trong bảng điều khiển quản trị OneEntry; SDK chỉ có thể đọc và chỉ lấy chúng. Mỗi dự án ít nhất có nhóm khách, nơi mà một khách truy cập không xác thực sẽ đến.

🚀 Bắt đầu nhanh​

Khởi tạo mô-đun từ defineOneEntry:


const { UserGroups } = defineOneEntry(
"your-project-url", {
"token": "your-app-token"
}
);

Đọc toàn bộ danh sách, hoặc bắt đầu từ đầu cây:

// Every group, flat, regardless of nesting.
const groups = await UserGroups.getUserGroups();

// Only the groups without a parent.
const roots = await UserGroups.getRootUserGroups();

roots.forEach((group) => {
console.log(group.identifier, group.localizeInfos.title);
});

🌳 Đi bộ trong cây​

Đọc các nhóm con của một nhóm theo đánh dấu của nhóm cha, không phải theo parentId:

const children = await UserGroups.getChildUserGroupsByMarker('guest');

Một nhóm không có nhóm con sẽ trả về một mảng rỗng.

⚠️ childrenCount là một chuỗi​

API gửi childrenCount dưới dạng một chuỗi, không phải một số:

{ "identifier": "guest", "childrenCount": "0" }

So sánh nó như một chuỗi, hoặc tự chuyển đổi nó:

if (Number(group.childrenCount) > 0) {
const children = await UserGroups.getChildUserGroupsByMarker(group.identifier);
}

📋 Phương thức​

Phương thứcKết quả trả về
getUserGroups()Mỗi nhóm dưới dạng một mảng phẳng
getRootUserGroups()Các nhóm không có nhóm cha
getUserGroupById(id)Một nhóm theo định danh của nó
getUserGroupByMarker(marker)Một nhóm theo đánh dấu của nó
getChildUserGroupsByMarker(marker)Các nhóm con của nhóm đã cho