Lewati ke konten utama

Pendahuluan

Baca kelompok pengguna proyek Anda: daftar datar, tingkat atas, satu kelompok, atau anak-anak dari satu kelompok.

Informasi lebih lanjut tentang antarmuka pengguna modul ini https://doc.oneentry.cloud/docs/category/users

🎯 Apa yang dilakukan modul ini?​

Modul UserGroups memungkinkan Anda membaca kelompok yang dimiliki pengunjung Anda. Sebuah kelompok menentukan apa yang dapat dilihat oleh pengunjung, dan kelompok-kelompok membentuk sebuah pohon — sebuah kelompok dapat memiliki orang tua dan anak-anak.

Kelompok-kelompok dibuat dan disusun dalam panel admin OneEntry; SDK bersifat hanya baca dan hanya mengambil mereka. Setiap proyek memiliki setidaknya kelompok tamu, yang merupakan tempat pengunjung yang tidak terautentikasi mendarat.

🚀 Memulai dengan Cepat​

Inisialisasi modul dari defineOneEntry:


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

Baca seluruh daftar, atau mulai dari atas pohon:

// 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);
});

🌳 Menelusuri pohon​

Baca anak-anak dari sebuah kelompok berdasarkan penanda orang tua, bukan berdasarkan parentId:

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

Sebuah kelompok tanpa anak akan mengembalikan array kosong.

⚠️ childrenCount adalah sebuah string​

API mengirimkan childrenCount sebagai string, bukan angka:

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

Bandingkan sebagai string, atau konversikan sendiri:

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

📋 Metode​

MetodeApa yang dikembalikannya
getUserGroups()Setiap kelompok sebagai array datar
getRootUserGroups()Kelompok tanpa orang tua
getUserGroupById(id)Satu kelompok berdasarkan identifikatornya
getUserGroupByMarker(marker)Satu kelompok berdasarkan penandanya
getChildUserGroupsByMarker(marker)Anak-anak dari kelompok yang diberikan