getUserGroups

Mengambil semua objek grup pengguna.

Deskripsi

Metode ini mengambil setiap grup pengguna dari proyek sebagai array datar, terlepas dari pengelompokan. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array dari objek IUserGroupEntity.

UserGroups.getUserGroups(langCode);

Parameter

langCode: string (opsional)
Kode bahasa. Default: "en_US".
contoh: "en_US"

Contoh

Contoh minimal

const response = await UserGroups.getUserGroups();

Dengan kode bahasa

const response = await UserGroups.getUserGroups('en_US');

Contoh respons

[
  {
    "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": {}
  }
]

Skema respons

Skema: IUserGroupEntity[]

id: number
Identifikasi grup pengguna.
contoh: 1

depth: number
Kedalaman pengelompokan relatif terhadap induk.
contoh: 0

parentId: number | null
Identifikasi grup induk, null untuk grup tingkat atas.
contoh: null

localizeInfos: ILocalizeInfo
Judul grup, dengan mempertimbangkan lokalisasi.

isVisible: boolean
Flag visibilitas.
contoh: true

childrenCount: string
Jumlah grup anak. API mengirimkannya sebagai string, bukan angka.
contoh: "0"

identifier: string
Identifikasi teks (penanda) grup.
contoh: "guest"

isSync: boolean
Flag sinkronisasi.
contoh: false

attributeValues: IAttributeValues
Nilai atribut grup.

version: number
Versi objek. Tidak selalu ada di setiap stand.
contoh: NaN

---