EventContext interface

زمینه ای که یک رویداد در آن رخ داده است.

یک EventContext شرح می دهد: - زمان وقوع یک رویداد. - شناسه منحصر به فرد رویداد. - منبعی که رویداد در آن رخ داده است، در صورت وجود. - مجوز درخواستی که رویداد را آغاز کرد، در صورت وجود و در دسترس بودن.

امضا:

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

خواص

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 ارائه شده به متد برای یک راه‌انداز پایگاه داده بیدرنگ.

امضا:

params: Params;

EventContext.resource

منبعی که رویداد را منتشر کرد.

مقادیر معتبر عبارتند از:

Analytics: projects/<projectId>/events/<analyticsEventType>

پایگاه داده بلادرنگ: projects/_/instances/<databaseInstance>/refs/<databasePath>

فضای ذخیره سازی: projects/_/buckets/<bucketName>/objects/<fileName>#<generation>

احراز هویت: projects/<projectId>

Pub/Sub: projects/<projectId>/topics/<topicName>

از آنجا که نمونه های پایگاه داده بیدرنگ و سطل های ذخیره سازی ابری در سطح جهانی منحصر به فرد هستند و به پروژه مرتبط نیستند، منابع آنها با projects/_ . Underscore نام پروژه معتبری نیست.

امضا:

resource: Resource;

EventContext.timestamp

مهر زمانی برای رویداد به عنوان یک رشته RFC 3339 .

امضا:

timestamp: string;