API במרחב שמות של Firebase (מדור קודם).
פונקציות
| פוּנקצִיָה | תיאור |
|---|---|
| שם האפליקציה) | |
| appCheck (אפליקציה) | מקבל את שירות AppCheck עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.appCheck() ללא ארגומנטים לגישה לשירות AppCheck של אפליקציית ברירת המחדל או כ- admin.appCheck(app) כדי לגשת לשירות AppCheck המשויך לאפליקציה ספציפית. |
| aut(app) | מקבל את שירות Auth עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.auth() ללא ארגומנטים לגישה לשירות ה- Auth של האפליקציה המוגדרת כברירת מחדל או כ- admin.auth(app) לגישה לשירות Auth המשויך לאפליקציה ספציפית. |
| מסד נתונים (אפליקציה) | מקבל את שירות מסד הנתונים עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא ל- admin.database() ללא ארגומנטים לגישה לשירות Database של אפליקציית ברירת המחדל או כ- admin.database(app) לגישה לשירות ה- Database המשויך לאפליקציה ספציפית. admin.database הוא גם מרחב שמות שניתן להשתמש בו כדי לגשת לקבועים גלובליים ולשיטות הקשורות לשירות Database . |
| firestore (אפליקציה) | |
| initializeApp(אפשרויות, שם) | |
| התקנות (אפליקציה) | מקבל את שירות ההתקנות עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.installations() ללא ארגומנטים כדי לגשת לשירות ההתקנה של האפליקציה המוגדרת כברירת מחדל או כ- admin.installations(app) כדי לגשת לשירות ההתקנה המשויך לאפליקציה ספציפית. |
| instanceId(app) | מקבל את שירות InstanceId עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.instanceId() ללא ארגומנטים כדי לגשת לשירות InstanceId של האפליקציה המוגדרת כברירת מחדל או בתור admin.instanceId(app) כדי לגשת לשירות InstanceId המשויך לאפליקציה ספציפית. |
| machineLearning (אפליקציה) | מקבל את שירות MachineLearning עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא ל- admin.machineLearning() ללא ארגומנטים לגישה לשירות MachineLearning של אפליקציית ברירת המחדל או כ- admin.machineLearning(app) כדי לגשת לשירות MachineLearning המשויך לאפליקציה ספציפית. |
| הודעות (אפליקציה) | מקבל את שירות ההודעות עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.messaging() ללא ארגומנטים לגישה לשירות Messaging של אפליקציית ברירת המחדל או כ- admin.messaging(app) לגישה לשירות Messaging המשויך לאפליקציה ספציפית. |
| projectManagement(אפליקציה) | מקבל את שירות ProjectManagement עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.projectManagement() ללא ארגומנטים לגישה לשירות ProjectManagement של אפליקציית ברירת המחדל, או כ- admin.projectManagement(app) כדי לגשת לשירות ProjectManagement המשויך לאפליקציה ספציפית. |
| remoteConfig(app) | מקבל את שירות RemoteConfig עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא admin.remoteConfig() ללא ארגומנטים לגישה לשירות RemoteConfig של אפליקציית ברירת המחדל או בתור admin.remoteConfig(app) כדי לגשת לשירות RemoteConfig המשויך לאפליקציה ספציפית. |
| securityRules(אפליקציה) | מקבל את שירות SecurityRules עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא ל- admin.securityRules() ללא ארגומנטים כדי לגשת לשירות SecurityRules של אפליקציית ברירת המחדל, או כ- admin.securityRules(app) כדי לגשת לשירות SecurityRules המשויך לאפליקציה ספציפית. |
| אחסון (אפליקציה) | מקבל את שירות האחסון עבור אפליקציית ברירת המחדל או אפליקציה נתונה. ניתן לקרוא ל- admin.storage() ללא ארגומנטים לגישה לשירות Storage של אפליקציית ברירת המחדל או כ- admin.storage(app) לגישה לשירות Storage המשויך לאפליקציה ספציפית. |
ממשקים
| מִמְשָׁק | תיאור |
|---|---|
| AppOptions | אפשרויות זמינות להעביר ל- initiizeApp() . |
| FirebaseArrayIndexError | סוג מורכב הכולל גם אובייקט FirebaseError וגם אינדקס שניתן להשתמש בו כדי לקבל את הפריט השגוי. |
| FirebaseError | FirebaseError היא תת-מחלקה של אובייקט JavaScript Error הסטנדרטי. בנוסף למחרוזת הודעה ומעקב מחסנית, היא מכילה קוד מחרוזת. |
| GoogleOAuthAccessToken | ממשק עבור אסימוני גישה של Google OAuth 2.0. |
| חשבון שירות |
מרחבי שמות
| מרחב שמות | תיאור |
|---|---|
| אפליקציה | |
| appCheck | |
| אישור | |
| תְעוּדָה | |
| מאגר מידע | |
| firestore | |
| התקנות | |
| instanceId | |
| למידת מכונה | |
| הודעות | |
| ניהול פרוייקט | |
| remoteconfig | |
| כללי אבטחה | |
| אִחסוּן |
משתנים
| מִשְׁתַנֶה | תיאור |
|---|---|
| אפליקציות | |
| SDK_VERSION |
app()
חֲתִימָה:
export declare function app(name?: string): app.App;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט |
החזרות:
appCheck()
מקבל את שירות AppCheck עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.appCheck() ללא ארגומנטים לגישה לשירות AppCheck של אפליקציית ברירת המחדל או כ- admin.appCheck(app) כדי לגשת לשירות AppCheck המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function appCheck(app?: App): appCheck.AppCheck;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית שעבורה ניתן להחזיר את שירות AppCheck . אם לא מסופק, שירות AppCheck המוגדר כברירת מחדל יוחזר. |
החזרות:
שירות AppCheck המוגדר כברירת מחדל אם לא מסופקת אפליקציה, או שירות AppCheck המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
דוגמה 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
auth()
מקבל את שירות Auth עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.auth() ללא ארגומנטים לגישה לשירות ה- Auth של האפליקציה המוגדרת כברירת מחדל או כ- admin.auth(app) לגישה לשירות Auth המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function auth(app?: App): auth.Auth;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה |
החזרות:
דוגמה 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
דוגמה 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
מאגר מידע()
מקבל את שירות מסד הנתונים עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא ל- admin.database() ללא ארגומנטים לגישה לשירות Database של אפליקציית ברירת המחדל או כ- admin.database(app) לגישה לשירות ה- Database המשויך לאפליקציה ספציפית.
admin.database הוא גם מרחב שמות שניתן להשתמש בו כדי לגשת לקבועים גלובליים ולשיטות הקשורות לשירות Database .
חֲתִימָה:
export declare function database(app?: App): database.Database;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה |
החזרות:
שירות Database המוגדר כברירת מחדל אם לא מסופקת אפליקציה או שירות Database המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
דוגמה 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
firestore()
חֲתִימָה:
export declare function firestore(app?: App): _firestore.Firestore;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה |
החזרות:
_firestore.Firestore
initializeApp()
חֲתִימָה:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפשרויות | AppOptions | |
| שֵׁם | חוּט |
החזרות:
התקנות()
מקבל את שירות ההתקנות עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.installations() ללא ארגומנטים כדי לגשת לשירות ההתקנה של האפליקציה המוגדרת כברירת מחדל או כ- admin.installations(app) כדי לגשת לשירות ההתקנה המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function installations(app?: App): installations.Installations;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית שאת שירות Installations שלה יש להחזיר. אם לא מסופק, שירות ברירת המחדל Installations מוחזר. |
החזרות:
שירות Installations ברירת המחדל אם לא מסופקת אפליקציה או שירות Installations המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
דוגמה 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
instanceId()
מקבל את שירות InstanceId עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.instanceId() ללא ארגומנטים כדי לגשת לשירות InstanceId של האפליקציה המוגדרת כברירת מחדל או בתור admin.instanceId(app) כדי לגשת לשירות InstanceId המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function instanceId(app?: App): instanceId.InstanceId;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית ששירות InstanceId שלה יחזור. אם לא יסופק, שירות ברירת המחדל InstanceId יוחזר. |
החזרות:
שירות ברירת המחדל InstanceId אם לא מסופקת אפליקציה או שירות InstanceId המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
דוגמה 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
למידת מכונה()
מקבל את שירות MachineLearning עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא ל- admin.machineLearning() ללא ארגומנטים לגישה לשירות MachineLearning של אפליקציית ברירת המחדל או כ- admin.machineLearning(app) כדי לגשת לשירות MachineLearning המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית ששירות MachineLearning שלה יחזור. אם לא יסופק, שירות MachineLearning המוגדר כברירת מחדל יוחזר. |
החזרות:
machineLearning.MachineLearning
שירות MachineLearning ברירת המחדל אם לא מסופקת אפליקציה או שירות MachineLearning המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
דוגמה 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
הודעות ()
מקבל את שירות ההודעות עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.messaging() ללא ארגומנטים לגישה לשירות Messaging של אפליקציית ברירת המחדל או כ- admin.messaging(app) לגישה לשירות Messaging המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function messaging(app?: App): messaging.Messaging;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית ששירות Messaging שלה להחזיר. אם לא יסופק, שירות ברירת המחדל Messaging יוחזר. |
החזרות:
שירות Messaging ברירת המחדל אם לא מסופקת אפליקציה או שירות Messaging המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
דוגמה 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
ניהול פרוייקט()
מקבל את שירות ProjectManagement עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.projectManagement() ללא ארגומנטים לגישה לשירות ProjectManagement של אפליקציית ברירת המחדל, או כ- admin.projectManagement(app) כדי לגשת לשירות ProjectManagement המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית ששירות ProjectManagement שלה יחזור. אם לא יסופק, שירות ברירת המחדל ProjectManagement יוחזר. * |
החזרות:
projectManagement.ProjectManagement
שירות ProjectManagement המוגדר כברירת מחדל אם לא מסופקת אפליקציה או שירות ProjectManagement המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
דוגמה 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
remoteConfig()
מקבל את שירות RemoteConfig עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא admin.remoteConfig() ללא ארגומנטים לגישה לשירות RemoteConfig של אפליקציית ברירת המחדל או בתור admin.remoteConfig(app) כדי לגשת לשירות RemoteConfig המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית שעבורה ניתן להחזיר את שירות RemoteConfig . אם לא מסופק, שירות RemoteConfig המוגדר כברירת מחדל מוחזר. |
החזרות:
שירות RemoteConfig המוגדר כברירת מחדל אם לא מסופקת אפליקציה, או שירות RemoteConfig המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
דוגמה 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
securityRules()
מקבל את שירות SecurityRules עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא ל- admin.securityRules() ללא ארגומנטים כדי לגשת לשירות SecurityRules של אפליקציית ברירת המחדל, או כ- admin.securityRules(app) כדי לגשת לשירות SecurityRules המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function securityRules(app?: App): securityRules.SecurityRules;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה | אפליקציה אופציונלית להחזרת שירות SecurityRules עבורה. אם לא מסופק, שירות ברירת המחדל SecurityRules מוחזר. |
החזרות:
ברירת המחדל של שירות כללי SecurityRules אם לא מסופקת אפליקציה, או שירות SecurityRules המשויך לאפליקציה שסופקה.
דוגמה 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
דוגמה 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
אִחסוּן()
מקבל את שירות האחסון עבור אפליקציית ברירת המחדל או אפליקציה נתונה.
ניתן לקרוא ל- admin.storage() ללא ארגומנטים לגישה לשירות Storage של אפליקציית ברירת המחדל או כ- admin.storage(app) לגישה לשירות Storage המשויך לאפליקציה ספציפית.
חֲתִימָה:
export declare function storage(app?: App): storage.Storage;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| אפליקציה | אפליקציה |
החזרות:
דוגמה 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
דוגמה 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
אפליקציות
חֲתִימָה:
apps: (app.App | null)[]
SDK_VERSION
חֲתִימָה:
SDK_VERSION: string