getUser
تجلب بيانات المستخدم المصادَق عليه. 🔐 تتطلب هذه الطريقة التفويض.
الوصف
يُعيد IUserEntity. مرّر langCode للحصول على البيانات بلغة أخرى؛ افتراضيًا يستخدم SDK قيمة langCode المعيّنة في defineOneEntry.
.getUser(
);
مخطط المعلمات
المخطط
langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"
أمثلة
مثال بسيط
// 1. Sign inawait AuthProvider.("email", { { , , }, { , } ]});
// 2. Fetch the userconst response = await Users.getUser();
مثال على الاستجابة
{
"id": 8,
"total": "1",
"identifier": "john@example.com",
"authProviderIdentifier": "email",
"formData": [
{
"marker": "name_reg",
"type": "string",
"value": "John"
},
{
"marker": "phone_reg",
"type": "string",
"value": "+19258382556"
}
],
"formIdentifier": "reg",
"groups": [
1
],
"state": {},
"rating": {},
"moduleFormConfigs": []
}
مخطط الاستجابة
المخطط: IUserEntity
id: number
معرّف الكائن.
مثال: 12345
identifier: string
اسم دخول المستخدم: بريد إلكتروني أو رقم هاتف أو اسم مستخدم، حسب موفّر المصادقة.
مثال: "user_12345"
authProviderIdentifier: string
علامة مزود المصادقة.
مثال: "auth_provider_12345"
formData: FormDataType[]
حقول النموذج مع قيمها.
مثال:
[
{
"marker": "last_name",
"type": "string",
"value": "Username"
}
]
formIdentifier: string
علامة النموذج.
مثال: "form_12345"
total: string
مهمل، لا تعتمد عليه. عدّاد خدمي يتسرّب إلى استجابة مستخدم واحد: دائمًا "1"، ولا يحمل أي بيانات عن المستخدم. لا يصفه مرجع API، وقد يختفي الحقل من الاستجابة.
مثال: "1"
groups: Array<string | number>
معرّفات مجموعات المستخدمين التي ينتمي إليها المستخدم.
مثال:
[
"group_1",
"group_2"
]
state: object
بيانات مخصصة بصيغة مفتاح-قيمة مخزنة مع المستخدم.
مثال:
{
"orderCount": 1
}
moduleFormConfigs: Array<IFormConfig>
إعدادات نماذج الوحدة المرتبطة بالمستخدم.
rating: IRating
بيانات التقييم: القيمة المتوسطة، والإعجابات وعدمها، وطريقة الحساب.
distance: number
مسافة جيب التمام إلى الاستعلام (الأقل يعني الأقرب). موجودة فقط في العناصر التي تُرجعها getUsersByVectorSearch().
مثال: 0.12
أمثلة الاستخدام
شرح خطوة بخطوة:
- تحديث المستخدم: اجلب المستخدم الحالي قبل بناء نموذج التعديل، ثم مرة أخرى بعد التحديث.
جربها مباشرة
شغّل هذه الطريقة تفاعليًا في بيئة JS SDK التجريبية. اربط Project URL وApp Token عند الزيارة الأولى، ثم افتح:
- تحديث المستخدم: اجلب المستخدم الحالي قبل بناء نموذج التعديل، ثم مرة أخرى بعد التحديث.
- OAuth: تحميل بيانات المستخدم بعد تسجيل الدخول عبر مزوّد OAuth.