getUserGroupByMarker

Mengambil objek grup pengguna tunggal berdasarkan penandanya.

Deskripsi

Metode ini mengambil objek grup pengguna tunggal berdasarkan pengenal teksnya (penanda). Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IUserGroupEntity.

UserGroups.getUserGroupByMarker(marker, langCode);

Parameter

marker: string
Pengenal teks dari grup pengguna.
contoh: "guest"

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

Contoh

Contoh minimal

const response = await UserGroups.getUserGroupByMarker('guest');

Contoh respons

{
  "id": 1,
  "depth": 0,
  "parentId": null,
  "localizeInfos": {
    "title": "Guest"
  },
  "isVisible": true,
  "childrenCount": "0",
  "identifier": "guest",
  "isSync": false,
  "attributeValues": {},
  "version": 0
}

Skema respons

Skema: IUserGroupEntity

id: number
Pengenal grup pengguna.
contoh: 1

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

parentId: number | null
Pengenal 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
Pengenal teks (penanda) dari grup.
contoh: "guest"

isSync: boolean
Flag sinkronisasi.
contoh: false

attributeValues: IAttributeValues
Nilai atribut dari grup.

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

---