API เนมสเปซของ Firebase (ดั้งเดิม)
ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
แอพ (ชื่อ) | |
แอพเช็ค(แอพ) | รับบริการ AppCheck สำหรับแอปเริ่มต้นหรือแอปที่ระบุ สามารถเรียก admin.appCheck() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ AppCheck ของแอปเริ่มต้น หรือเรียกเป็น admin.appCheck(app) เพื่อเข้าถึงบริการ AppCheck ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ |
รับรองความถูกต้อง (แอป) | รับบริการ รับรองความถูกต้อง สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.auth() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ Auth ของแอปเริ่มต้นหรือเป็น admin.auth(app) เพื่อเข้าถึงบริการ Auth ที่เชื่อมโยงกับแอปเฉพาะ |
ฐานข้อมูล (แอป) | รับบริการ ฐานข้อมูล สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.database() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ Database ของแอปเริ่มต้นหรือเป็น admin.database(app) เพื่อเข้าถึงบริการ Database ที่เกี่ยวข้องกับแอปเฉพาะ admin.database ยังเป็นเนมสเปซที่สามารถใช้เพื่อเข้าถึงค่าคงที่ส่วนกลางและวิธีการที่เกี่ยวข้องกับบริการ Database |
ร้านไฟ (แอป) | |
InitializeApp (ตัวเลือก, ชื่อ) | |
การติดตั้ง (แอป) | รับบริการ การติดตั้ง สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.installations() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ การติดตั้ง ของแอปเริ่มต้น หรือเป็น admin.installations(app) เพื่อเข้าถึงบริการ การติดตั้ง ที่เกี่ยวข้องกับแอปเฉพาะ |
รหัสอินสแตนซ์ (แอป) | รับบริการ InstanceId สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.instanceId() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ InstanceId ของแอปเริ่มต้น หรือเรียกเป็น admin.instanceId(app) เพื่อเข้าถึงบริการ InstanceId ที่เชื่อมโยงกับแอปเฉพาะ |
แมชชีนเลิร์นนิง (แอป) | รับบริการ MachineLearning สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.machineLearning() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ MachineLearning ของแอปเริ่มต้น หรือเรียกเป็น admin.machineLearning(app) เพื่อเข้าถึงบริการ MachineLearning ที่เชื่อมโยงกับแอปเฉพาะ |
การส่งข้อความ (แอป) | รับบริการ ส่งข้อความ สำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.messaging() สามารถเรียกโดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้นหรือเป็น admin.messaging(app) เพื่อเข้าถึงบริการ Messaging ที่เกี่ยวข้องกับแอปเฉพาะ |
การจัดการโครงการ (แอป) | รับบริการ ProjectManagement สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.projectManagement() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ ProjectManagement ของแอปเริ่มต้น หรือเรียกเป็น admin.projectManagement(app) เพื่อเข้าถึงบริการ ProjectManagement ที่เชื่อมโยงกับแอปเฉพาะ |
การกำหนดค่าระยะไกล (แอป) | รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.remoteConfig() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ RemoteConfig ของแอปเริ่มต้น หรือเรียกเป็น admin.remoteConfig(app) เพื่อเข้าถึงบริการ RemoteConfig ที่เชื่อมโยงกับแอปเฉพาะ |
กฎความปลอดภัย (แอป) | รับบริการ SecurityRules สำหรับแอปเริ่มต้นหรือแอปที่ระบุ สามารถเรียก admin.securityRules() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ SecurityRules ของแอปเริ่มต้น หรือเรียกเป็น admin.securityRules(app) เพื่อเข้าถึงบริการ SecurityRules ที่เชื่อมโยงกับแอปเฉพาะ |
ที่เก็บข้อมูล (แอป) | รับบริการ จัดเก็บข้อมูล สำหรับแอปเริ่มต้นหรือแอปที่กำหนด สามารถเรียก admin.storage() โดยไม่มีข้อโต้แย้งเพื่อเข้าถึงบริการ Storage ของแอปเริ่มต้น หรือเป็น admin.storage(app) เพื่อเข้าถึงบริการ Storage ที่เชื่อมโยงกับแอปเฉพาะ |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
ตัวเลือกแอป | ตัวเลือกที่มีให้ส่งผ่านไปยัง InitializeApp() . |
ข้อผิดพลาด FirebaseArrayIndex | ประเภทคอมโพสิตซึ่งรวมถึงวัตถุ FirebaseError และดัชนีที่สามารถใช้เพื่อรับรายการที่ผิดพลาด |
ข้อผิดพลาดของ Firebase | FirebaseError เป็นคลาสย่อยของอ็อบเจ็กต์ Error JavaScript มาตรฐาน นอกจากสตริงข้อความและการติดตามสแต็กแล้ว ยังมีโค้ดสตริงอีกด้วย |
GoogleOAuthAccessToken | อินเทอร์เฟซสำหรับโทเค็นการเข้าถึง Google OAuth 2.0 |
บัญชีบริการ |
เนมสเปซ
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
แอพ | |
SDK_VERSION |
แอป()
ลายเซ็น:
export declare function app(name?: string): app.App;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ชื่อ | เชือก |
ผลตอบแทน:
แอพเช็ค()
รับบริการ 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);
รับรองความถูกต้อง()
รับบริการ รับรองความถูกต้อง สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก 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);
ร้านขายไฟ ()
ลายเซ็น:
export declare function firestore(app?: App): _firestore.Firestore;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอป | แอป |
ผลตอบแทน:
_firestore.Firestore
เตรียมใช้งานแอป()
ลายเซ็น:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือกแอป | |
ชื่อ | เชือก |
ผลตอบแทน:
การติดตั้ง()
รับบริการ การติดตั้ง สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก 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 สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก 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
ที่เชื่อมโยงกับแอปที่ให้มา
ตัวอย่างที่ 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
ที่เชื่อมโยงกับแอปที่ให้มา
ตัวอย่างที่ 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 สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก 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 สำหรับแอปเริ่มต้นหรือแอปที่ระบุ
สามารถเรียก 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