แอป Firebase
แพ็คเกจนี้ประสานงานการสื่อสารระหว่างส่วนประกอบ Firebase ต่างๆ
ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
ฟังก์ชั่น(แอพ, ...) | |
ลบแอพ(แอพ) | ทำให้แอปนี้ไม่สามารถใช้งานได้และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดหมดไป |
การทำงาน() | |
รับแอพ() | อาร์เรย์ (อ่านอย่างเดียว) ของแอปที่เตรียมใช้งานทั้งหมด |
เตรียมใช้งานแอป() | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
ฟังก์ชัน (libraryKeyOrName, ...) | |
registerVersion (libraryKeyOrName, เวอร์ชัน, ตัวแปร) | ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม |
ฟังก์ชั่น (logCallback, ... ) | |
onLog(logCallback, ตัวเลือก) | ตั้งค่าตัวจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด |
ฟังก์ชั่น (logLevel, ... ) | |
setLogLevel (ระดับบันทึก) | ตั้งค่าระดับบันทึกสำหรับ Firebase SDK ทั้งหมด ประเภทบันทึกทั้งหมดที่อยู่เหนือระดับบันทึกปัจจุบันจะถูกบันทึก (เช่น หากคุณตั้งค่าระดับบันทึกเป็น info ข้อผิดพลาดจะถูกบันทึก แต่บันทึก debug และ verbose จะไม่ได้รับ) |
ฟังก์ชั่น(ชื่อ,...) | |
getApp (ชื่อ) | ดึงข้อมูลอินสแตนซ์ FirebaseApp เมื่อเรียกโดยไม่มีข้อโต้แย้ง แอปเริ่มต้นจะถูกส่งกลับ เมื่อระบุชื่อแอปแล้ว แอปที่สอดคล้องกับชื่อนั้นจะถูกส่งกลับ มีข้อยกเว้นเกิดขึ้นหากแอปที่กำลังดึงข้อมูลยังไม่ได้เริ่มต้น |
ฟังก์ชั่น(ตัวเลือก, ...) | |
InitializeApp (ตัวเลือก, ชื่อ) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp ดู เพิ่ม Firebase ให้กับแอปของคุณ และ เริ่มต้นหลายโปรเจ็กต์ สำหรับเอกสารประกอบโดยละเอียด |
เตรียมใช้งานแอป (ตัวเลือก, กำหนดค่า) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
แอป Firebase | FirebaseApp เก็บข้อมูลการเริ่มต้นสำหรับชุดบริการ อย่าเรียกตัวสร้างนี้โดยตรง ให้ใช้ InitializeApp() เพื่อสร้างแอปแทน |
การตั้งค่า FirebaseApp | ตัวเลือกการกำหนดค่าที่กำหนดให้กับ InitializeApp() |
ตัวเลือก Firebase | ออบเจ็กต์การกำหนดค่า Firebase ประกอบด้วยชุดพารามิเตอร์ที่บริการต้องการเพื่อให้สามารถสื่อสารกับ API เซิร์ฟเวอร์ Firebase ได้สำเร็จ และเพื่อเชื่อมโยงข้อมูลไคลเอ็นต์กับโปรเจ็กต์ Firebase และแอปพลิเคชัน Firebase ของคุณ โดยทั่วไปแล้วออบเจ็กต์นี้จะถูกเติมโดยคอนโซล Firebase ในการตั้งค่าโปรเจ็กต์ ดูเพิ่มเติม: เรียนรู้เกี่ยวกับออบเจ็กต์การกำหนดค่า Firebase . |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
SDK_VERSION | เวอร์ชัน SDK ปัจจุบัน |
ฟังก์ชั่น(แอพ, ...)
ลบแอพ(แอพ)
ทำให้แอปนี้ไม่สามารถใช้งานได้และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดหมดไป
ลายเซ็น:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอป | แอป Firebase |
ผลตอบแทน:
สัญญา<โมฆะ>
ตัวอย่าง
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
การทำงาน()
รับแอพ()
อาร์เรย์ (อ่านอย่างเดียว) ของแอปที่เตรียมใช้งานทั้งหมด
ลายเซ็น:
export declare function getApps(): FirebaseApp[];
ผลตอบแทน:
แอป Firebase []
เตรียมใช้งานแอป()
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ลายเซ็น:
export declare function initializeApp(): FirebaseApp;
ผลตอบแทน:
ฟังก์ชัน (libraryKeyOrName, ...)
registerVersion (libraryKeyOrName, เวอร์ชัน, ตัวแปร)
ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม
ลายเซ็น:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ไลบรารีKeyOrName | เชือก | |
รุ่น | เชือก | เวอร์ชันปัจจุบันของไลบรารีนั้น |
ตัวแปร | เชือก | ตัวแปรบันเดิล เช่น โหนด rn ฯลฯ |
ผลตอบแทน:
เป็นโมฆะ
ฟังก์ชั่น (logCallback, ... )
onLog(logCallback, ตัวเลือก)
ตั้งค่าตัวจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด
ลายเซ็น:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
เข้าสู่ระบบโทรกลับ | LogCallback | โมฆะ | ตัวจัดการบันทึกที่กำหนดเองซึ่งเป็นทางเลือกซึ่งเรียกใช้โค้ดผู้ใช้ทุกครั้งที่ Firebase SDK ทำการเรียกการบันทึก |
ตัวเลือก | ตัวเลือกบันทึก |
ผลตอบแทน:
เป็นโมฆะ
ฟังก์ชั่น (logLevel, ... )
setLogLevel (ระดับบันทึก)
ตั้งค่าระดับบันทึกสำหรับ Firebase SDK ทั้งหมด
ประเภทบันทึกทั้งหมดที่อยู่เหนือระดับบันทึกปัจจุบันจะถูกบันทึก (เช่น หากคุณตั้งค่าระดับบันทึกเป็น info
ข้อผิดพลาดจะถูกบันทึก แต่บันทึก debug
และ verbose
จะไม่ถูกบันทึกไว้)
ลายเซ็น:
export declare function setLogLevel(logLevel: LogLevelString): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ระดับบันทึก | LogLevelString |
ผลตอบแทน:
เป็นโมฆะ
ฟังก์ชั่น(ชื่อ,...)
getApp (ชื่อ)
ดึงข้อมูลอินสแตนซ์ FirebaseApp
เมื่อเรียกโดยไม่มีข้อโต้แย้ง แอปเริ่มต้นจะถูกส่งกลับ เมื่อระบุชื่อแอปแล้ว แอปที่สอดคล้องกับชื่อนั้นจะถูกส่งกลับ
มีข้อยกเว้นเกิดขึ้นหากแอปที่กำลังดึงข้อมูลยังไม่ได้เริ่มต้น
ลายเซ็น:
export declare function getApp(name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ชื่อ | เชือก | ชื่อทางเลือกของแอปที่จะส่งคืน หากไม่มีการระบุชื่อ ค่าเริ่มต้นคือ "[DEFAULT]" |
ผลตอบแทน:
แอปที่สอดคล้องกับชื่อแอปที่ให้ไว้ หากไม่มีชื่อแอป ระบบจะส่งคืนแอปเริ่มต้น
ตัวอย่างที่ 1
// Return the default app
const app = getApp();
ตัวอย่างที่ 2
// Return a named app
const otherApp = getApp("otherApp");
ฟังก์ชั่น(ตัวเลือก, ...)
InitializeApp (ตัวเลือก, ชื่อ)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ดู เพิ่ม Firebase ให้กับแอปของคุณ และ เริ่มต้นหลายโปรเจ็กต์ สำหรับเอกสารประกอบโดยละเอียด
ลายเซ็น:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก Firebase | ตัวเลือกในการกำหนดค่าบริการของแอป |
ชื่อ | เชือก | ชื่อทางเลือกของแอปที่จะเริ่มต้น หากไม่มีการระบุชื่อ ค่าเริ่มต้นคือ "[DEFAULT]" |
ผลตอบแทน:
แอปเริ่มต้น
ตัวอย่างที่ 1
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
ตัวอย่างที่ 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
เตรียมใช้งานแอป (ตัวเลือก, กำหนดค่า)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ลายเซ็น:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก Firebase | ตัวเลือกในการกำหนดค่าบริการของแอป |
กำหนดค่า | การตั้งค่า FirebaseApp | การกำหนดค่า FirebaseApp |
ผลตอบแทน:
SDK_VERSION
เวอร์ชัน SDK ปัจจุบัน
ลายเซ็น:
SDK_VERSION: string