EventContext interface

السياق الذي وقع فيه الحدث.

يصف EventContext: - الوقت الذي وقع فيه الحدث. - معرّف فريد للحدث - المورد الذي يقع عليه الحدث، إذا كان ذلك منطبقًا. - تفويض الطلب الذي أدّى إلى ظهور الحدث، إذا كان ذلك منطبقًا ومتاحًا

Signature:

export interface EventContext<Params = Record<string, string>>

أماكن إقامة

الموقع النوع الوصف
المصادقة {Token: object; uid: string; } معلومات المصادقة للمستخدم الذي شغَّل الدالة.
نوع المصادقة "المشرِف" | "المستخدم" | "غير معتمَد" مستوى الأذونات للمستخدم.
eventId السلسلة المعرّف الفريد للحدث
eventType السلسلة نوع الحدث.
المَعلمات المَعلمات كائن يحتوي على قيم أحرف البدل في المعلمة path المقدمة لطريقة تشغيل قاعدة البيانات في الوقت الفعلي
المورد المورد المورد الذي انبع من الحدث.
الطابع الزمني السلسلة طابع زمني للحدث كسلسلة RFC 3339

EventContext.auth

معلومات المصادقة للمستخدم الذي شغَّل الدالة.

يحتوي هذا العنصر على سمتَي uid وtoken للمستخدمين الذين تمت مصادقتهم. لمزيد من التفاصيل، بما في ذلك مفاتيح الرموز المميّزة، يُرجى الاطّلاع على مرجع قواعد الأمان.

تتم تعبئة هذا الحقل فقط لعوامل تشغيل قاعدة البيانات في الوقت الفعلي والدوال القابلة للاستدعاء. بالنسبة إلى مستخدم لم تتم مصادقته، يكون هذا الحقل خاليًا. ولا يتوفّر هذا الحقل بالنسبة إلى المستخدمين المشرفين على Firebase وأنواع الأحداث التي لا توفّر معلومات عن المستخدمين.

Signature:

auth?: {
        token: object;
        uid: string;
    };

EventContext.authType

مستوى الأذونات للمستخدم.

القيم الصالحة هي:

  • ADMIN: مستخدم مطوّر برامج أو مستخدم تمت مصادقته من خلال حساب خدمة

  • USER: مستخدم معروف

  • UNAUTHENTICATED: إجراء لم تتم المصادقة عليه

  • null: لأنواع الأحداث التي لا توفّر معلومات عن المستخدم (جميعها باستثناء "قاعدة بيانات الوقت الفعلي")

Signature:

authType?: "ADMIN" | "USER" | "UNAUTHENTICATED";

رقم تعريف الحدث

المعرّف الفريد للحدث

Signature:

eventId: string;

EventContext.eventType

نوع الحدث.

القيم المتاحة:

  • google.analytics.event.log

  • google.firebase.auth.user.create

  • google.firebase.auth.user.delete

  • google.firebase.database.ref.write

  • google.firebase.database.ref.create

  • google.firebase.database.ref.update

  • google.firebase.database.ref.delete

  • google.firestore.document.write

  • google.firestore.document.create

  • google.firestore.document.update

  • google.firestore.document.delete

  • google.pubsub.topic.publish

  • google.firebase.remoteconfig.update

  • google.storage.object.finalize

  • google.storage.object.archive

  • google.storage.object.delete

  • google.storage.object.metadataUpdate

  • google.testing.testMatrix.complete

Signature:

eventType: string;

مَعلمة EventContext.params

كائن يحتوي على قيم أحرف البدل في المعلمة path المقدمة لطريقة تشغيل قاعدة البيانات في الوقت الفعلي

Signature:

params: Params;

مورد EventContext.resource

المورد الذي انبع من الحدث.

القيم الصالحة هي:

إحصاءات: projects/<projectId>/events/<analyticsEventType>

قاعدة بيانات الوقت الفعلي: projects/_/instances/<databaseInstance>/refs/<databasePath>

مساحة التخزين: projects/_/buckets/<bucketName>/objects/<fileName>#<generation>

المصادقة: projects/<projectId>

نشر/اشتراك: projects/<projectId>/topics/<topicName>

بما أنّ مثيلات قاعدة البيانات في الوقت الفعلي وحِزم Cloud Storage فريدة على مستوى العالم ولا ترتبط بالمشروع، تبدأ مواردها بـ projects/_. الشرطة السفلية ليست اسم مشروع صالحًا.

Signature:

resource: Resource;

EventContext.timestamp

طابع زمني للحدث كسلسلة RFC 3339

Signature:

timestamp: string;