السياق الذي وقع فيه الحدث.
يصف EventContext: - الوقت الذي وقع فيه الحدث. - معرف فريد للحدث. - المصدر الذي وقع عليه الحدث، إن أمكن. - تفويض الطلب الذي أثار الحدث، إن وجد وتوافر.
إمضاء:
export interface EventContext<Params = Record<string, string>>
ملكيات
ملكية | يكتب | وصف |
---|---|---|
مصادقة | { رمز: كائن؛ معرف المستخدم: سلسلة؛ } | معلومات المصادقة للمستخدم الذي قام بتشغيل الوظيفة. |
authType | "المسؤول" | "المستخدم" | "غير مصادق عليه" | مستوى الأذونات للمستخدم. |
معرف الحدث | خيط | المعرف الفريد للحدث. |
نوع الحدث | خيط | نوع اللقاء. |
المعلمات | بارامس | كائن يحتوي على قيم أحرف البدل في معلمة path المتوفرة للطريقة الخاصة بمشغل قاعدة بيانات Realtime. |
الموارد | الموارد | المورد الذي أرسل الحدث. |
الطابع الزمني | خيط | الطابع الزمني للحدث كسلسلة RFC 3339 . |
EventContext.auth
معلومات المصادقة للمستخدم الذي قام بتشغيل الوظيفة.
يحتوي هذا الكائن على خصائص uid
و token
للمستخدمين المعتمدين. لمزيد من التفاصيل بما في ذلك مفاتيح الرمز المميز، راجع مرجع قواعد الأمان .
يتم ملء هذا الحقل فقط لمشغلات قاعدة بيانات الوقت الحقيقي والوظائف القابلة للاستدعاء. بالنسبة لمستخدم لم تتم مصادقته، هذا الحقل فارغ. بالنسبة لمستخدمي مسؤول Firebase وأنواع الأحداث التي لا توفر معلومات المستخدم، فإن هذا الحقل غير موجود.
إمضاء:
auth?: {
token: object;
uid: string;
};
EventContext.authType
مستوى الأذونات للمستخدم.
القيم الصالحة هي:
ADMIN
: مستخدم المطور أو المستخدم الذي تمت مصادقته عبر حساب الخدمة.USER
: مستخدم معروف.UNAUTHENTICATED
: عمل غير مصادق عليهnull
: بالنسبة لأنواع الأحداث التي لا توفر معلومات المستخدم (جميعها باستثناء قاعدة بيانات الوقت الحقيقي).
إمضاء:
authType?: "ADMIN" | "USER" | "UNAUTHENTICATED";
EventContext.eventId
المعرف الفريد للحدث.
إمضاء:
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
إمضاء:
eventType: string;
EventContext.params
كائن يحتوي على قيم أحرف البدل في معلمة path
المتوفرة للطريقة الخاصة بمشغل قاعدة بيانات Realtime.
إمضاء:
params: Params;
EventContext.resource
المورد الذي أرسل الحدث.
القيم الصالحة هي:
التحليلات: projects/<projectId>/events/<analyticsEventType>
قاعدة بيانات الوقت الحقيقي: projects/_/instances/<databaseInstance>/refs/<databasePath>
التخزين: projects/_/buckets/<bucketName>/objects/<fileName>#<generation>
المصادقة: projects/<projectId>
Pub/Sub: projects/<projectId>/topics/<topicName>
نظرًا لأن مثيلات Realtime Database ومستودعات التخزين السحابي فريدة عالميًا وغير مرتبطة بالمشروع، فإن مواردها تبدأ projects/_
. الشرطة السفلية ليست اسم مشروع صالحًا.
إمضاء:
resource: Resource;
EventContext.timestamp
الطابع الزمني للحدث كسلسلة RFC 3339 .
إمضاء:
timestamp: string;