EventContext interface

ההקשר שבו התרחש אירוע.

EventContext מתאר: - הזמן שבו התרחש אירוע. - מזהה ייחודי של האירוע. - המשאב שבו התרחש האירוע, אם רלוונטי. - אישור הבקשה שהפעילה את האירוע, אם רלוונטי וזמין.

חֲתִימָה:

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

נכסים

תכונה	סוּג	תיאור
אישור	{ token: object; uid: מחרוזת; }	מידע אימות עבור המשתמש שהפעיל את הפונקציה.
authType	"אדמין" | "משתמש" | "לא מאומת"	רמת ההרשאות של משתמש.
eventId	חוּט	המזהה הייחודי של האירוע.
סוג אירוע	חוּט	סוג של אירוע.
params	פרמס	אובייקט המכיל את ערכי התווים הכלליים בפרמטר path שסופק למתודה עבור טריגר של מסד נתונים בזמן אמת.
מַשׁאָב	מַשׁאָב	המשאב שפלט את האירוע.
חותמת זמן	חוּט	חותמת זמן לאירוע כמחרוזת 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 שסופק למתודה עבור טריגר של מסד נתונים בזמן אמת.

חֲתִימָה:

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/_ . קו תחתון אינו שם פרויקט חוקי.

חֲתִימָה:

resource: Resource;

EventContext.timestamp

חותמת זמן לאירוע כמחרוזת RFC 3339 .

חֲתִימָה:

timestamp: string;