getRootUserGroups
Lấy tất cả các đối tượng nhóm người dùng cấp cao nhất.
Mô tả
Phương thức này truy xuất các nhóm người dùng ở cấp cao nhất - những nhóm không có cha. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng IUserGroupEntity.
UserGroups.getRootUserGroups(langCode);
Tham số
langCode: string (tùy chọn)
Mã ngôn ngữ. Mặc định: "en_US".
ví dụ: "en_US"
Ví dụ
Ví dụ tối thiểu
const response = await UserGroups.getRootUserGroups();
Phản hồi ví dụ
[
{
"id": 1,
"depth": 0,
"parentId": null,
"localizeInfos": {
"title": "Guest"
},
"isVisible": true,
"childrenCount": "0",
"identifier": "guest",
"isSync": false,
"attributeValues": {}
},
{
"id": 2,
"depth": 0,
"parentId": null,
"localizeInfos": {
"title": "sd"
},
"isVisible": true,
"childrenCount": "0",
"identifier": "wewe",
"isSync": false,
"attributeValues": {}
}
]
Sơ đồ phản hồi
Sơ đồ: IUserGroupEntity[]
id: number
Định danh của nhóm người dùng.
ví dụ: 1
depth: number
Độ sâu lồng ghép so với nhóm cha.
ví dụ: 0
parentId: number | null
Định danh của nhóm cha, null cho một nhóm cấp cao nhất.
ví dụ: null
localizeInfos: ILocalizeInfo
Tiêu đề của nhóm, có tính đến việc địa phương hóa.
isVisible: boolean
Cờ hiển thị.
ví dụ: true
childrenCount: string
Số lượng nhóm con. API gửi dưới dạng chuỗi, không phải số.
ví dụ: "0"
identifier: string
Định danh văn bản (dấu hiệu) của nhóm.
ví dụ: "guest"
isSync: boolean
Cờ đồng bộ hóa.
ví dụ: false
attributeValues: IAttributeValues
Giá trị thuộc tính của nhóm.
version: number
Phiên bản của đối tượng. Không có trên mọi phiên bản.
ví dụ: NaN