แอป Firebase
แพ็กเกจนี้จะประสานการสื่อสารระหว่างคอมโพเนนต์ Firebase ต่างๆ
ฟังก์ชัน
ฟังก์ชัน | คำอธิบาย |
---|---|
ฟังก์ชัน(แอป, ...) | |
deleteApp(แอป) | แสดงผลให้แอปนี้ใช้งานไม่ได้และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่าง |
function() | |
getApps() | อาร์เรย์ (อ่านอย่างเดียว) ของแอปเริ่มต้นทั้งหมด |
initializeApp() | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, เวอร์ชัน, รูปแบบ) | ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม |
function(logCallback, ...) | |
onLog(logCallback, ตัวเลือก) | ตั้งค่าเครื่องจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด |
function(logLevel, ...) | |
setLogLevel(logLevel) | ตั้งค่าระดับการบันทึกสำหรับ Firebase SDK ทั้งหมดระบบจะเก็บบันทึกทุกประเภทที่อยู่สูงกว่าระดับการบันทึกปัจจุบัน (กล่าวคือ หากคุณตั้งค่าระดับการบันทึกเป็น info ระบบจะบันทึกข้อผิดพลาด แต่จะไม่มีการบันทึก debug และ verbose ) |
ฟังก์ชัน(ชื่อ, ...) | |
getApp(name) | เรียกข้อมูลอินสแตนซ์ FirebaseAppเมื่อเรียกใช้โดยไม่มีอาร์กิวเมนต์ ระบบจะแสดงผลแอปเริ่มต้น เมื่อระบุชื่อแอปแล้ว ระบบจะแสดงผลแอปที่สอดคล้องกับชื่อนั้นระบบจะมีข้อยกเว้นหากแอปที่กำลังดึงข้อมูลมายังไม่ได้เริ่มต้น |
ฟังก์ชัน(ตัวเลือก, ...) | |
initializeApp(ตัวเลือก, ชื่อ) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseAppดูเอกสารโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์ |
initializeApp(ตัวเลือก การกำหนดค่า) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
initializeServerApp(ตัวเลือก, การกำหนดค่า) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseServerAppFirebaseServerApp คล้ายกับ FirebaseApp แต่มีจุดประสงค์เพื่อการดำเนินการในสภาพแวดล้อมการแสดงผลฝั่งเซิร์ฟเวอร์เท่านั้น การเริ่มต้นจะไม่สำเร็จหากเรียกใช้จากสภาพแวดล้อมของเบราว์เซอร์ดูเอกสารโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปของคุณและเริ่มต้นหลายโปรเจ็กต์ |
อินเทอร์เฟซ
อินเทอร์เฟซ | คำอธิบาย |
---|---|
แอป Firebase | FirebaseApp เก็บข้อมูลการเริ่มต้นของคอลเล็กชันบริการอย่าเรียกใช้เครื่องมือสร้างนี้โดยตรง แต่ให้ใช้ initializeApp() เพื่อสร้างแอปแทน |
การตั้งค่าแอป Firebase | ตัวเลือกการกำหนดค่าที่กำหนดให้กับ initializeApp() |
ตัวเลือก Firebase | ออบเจ็กต์การกำหนดค่า Firebase มีชุดพารามิเตอร์ที่บริการต้องใช้เพื่อให้สื่อสารกับ API ของเซิร์ฟเวอร์ Firebase ได้สำเร็จและเพื่อเชื่อมโยงข้อมูลไคลเอ็นต์กับโปรเจ็กต์ Firebase และแอปพลิเคชัน Firebase โดยปกติแล้ว ออบเจ็กต์นี้จะสร้างขึ้นโดยคอนโซล Firebase ในการตั้งค่าโปรเจ็กต์ ดูเพิ่มเติมเกี่ยวกับออบเจ็กต์การกำหนดค่าของ Firebase |
แอป FirebaseServer | FirebaseServerApp มีข้อมูลการเริ่มต้นสำหรับคอลเล็กชันของบริการที่ทำงานอยู่ในสภาพแวดล้อมของเซิร์ฟเวอร์อย่าเรียกใช้ตัวสร้างนี้โดยตรง โปรดใช้ initializeServerApp() เพื่อสร้างแอปแทน |
FirebaseServerAppSettings | ตัวเลือกการกำหนดค่าที่ให้กับ initializeServerApp() |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
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);
});
ฟังก์ชัน()
getApps()
อาร์เรย์ (อ่านอย่างเดียว) ของแอปเริ่มต้นทั้งหมด
ลายเซ็น:
export declare function getApps(): FirebaseApp[];
การคืนสินค้า:
defaultizeApp()
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ลายเซ็น:
export declare function initializeApp(): FirebaseApp;
การคืนสินค้า:
ฟังก์ชัน(libraryKeyOrName, ...)
เวอร์ชันที่ลงทะเบียน(libraryKeyOrName, เวอร์ชัน, รูปแบบ)
ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม
ลายเซ็น:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ชื่อหรือรหัสไลบรารี | สตริง | |
เวอร์ชัน | สตริง | เวอร์ชันปัจจุบันของไลบรารีนั้น |
variant | สตริง | ตัวแปรแพ็กเกจ เช่น โหนด rn ฯลฯ |
การคืนสินค้า:
เป็นโมฆะ
ฟังก์ชัน(logCallback, ...)
onLog(LogCallback, ตัวเลือก)
ตั้งค่าเครื่องจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด
ลายเซ็น:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
บันทึก Callback | LogCallback | ค่าว่าง | เครื่องจัดการบันทึกที่กำหนดเองที่ไม่บังคับซึ่งจะเรียกใช้โค้ดผู้ใช้เมื่อใดก็ตามที่ Firebase SDK ทำการเรียกใช้การบันทึก |
ตัวเลือก | ตัวเลือกบันทึก |
การคืนสินค้า:
เป็นโมฆะ
ฟังก์ชัน(logLevel, ...)
setLogLevel(logLevel)
ตั้งค่าระดับการบันทึกสำหรับ Firebase SDK ทั้งหมด
ประเภทบันทึกทั้งหมดที่อยู่เหนือระดับการบันทึกปัจจุบันจะได้รับการบันทึก (กล่าวคือ หากคุณตั้งค่าระดับการบันทึกเป็น info
ระบบจะบันทึกข้อผิดพลาด แต่จะไม่มีการบันทึก debug
และ verbose
)
ลายเซ็น:
export declare function setLogLevel(logLevel: LogLevelString): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ระดับบันทึก | สตริงระดับบันทึก |
การคืนสินค้า:
เป็นโมฆะ
ฟังก์ชัน(ชื่อ, ...)
getApp(name)
เรียกข้อมูลอินสแตนซ์ FirebaseApp
เมื่อเรียกใช้โดยไม่มีอาร์กิวเมนต์ ระบบจะแสดงผลแอปเริ่มต้น เมื่อมีการระบุชื่อแอป ระบบจะแสดงผลแอปที่เกี่ยวข้องกับชื่อนั้น
อาจมีข้อยกเว้นหากแอปที่ดึงข้อมูลมายังไม่ได้เริ่มต้น
ลายเซ็น:
export declare function getApp(name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
name | สตริง | ชื่อที่ไม่บังคับของแอปที่จะส่งคืน หากไม่ได้ระบุชื่อไว้ ค่าเริ่มต้นจะเป็น "[DEFAULT]" |
การคืนสินค้า:
แอปที่สอดคล้องกับชื่อแอปที่ระบุ หากไม่ได้ระบุชื่อแอปไว้ ระบบจะแสดงผลแอปเริ่มต้น
ตัวอย่างที่ 1
// Return the default app
const app = getApp();
ตัวอย่างที่ 2
// Return a named app
const otherApp = getApp("otherApp");
ฟังก์ชัน(ตัวเลือก, ...)
defaultizeApp(ตัวเลือก ชื่อ)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ดูเอกสารโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์
ลายเซ็น:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก Firebase | ตัวเลือกเพื่อกำหนดค่าบริการของแอป |
name | สตริง | ชื่อที่ไม่บังคับของแอปที่จะใช้เริ่มต้น หากไม่ได้ระบุชื่อไว้ ค่าเริ่มต้นจะเป็น "[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");
defaultizeApp(ตัวเลือก การกำหนดค่า)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ลายเซ็น:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก Firebase | ตัวเลือกเพื่อกำหนดค่าบริการของแอป |
การกำหนดค่า | การตั้งค่าแอป Firebase | การกำหนดค่าแอป Firebase |
การคืนสินค้า:
defaultizeServerApp(ตัวเลือก การกำหนดค่า)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseServerApp
FirebaseServerApp
คล้ายกับ FirebaseApp
แต่มีไว้สำหรับการดำเนินการในสภาพแวดล้อมการแสดงผลฝั่งเซิร์ฟเวอร์เท่านั้น การเริ่มต้นจะล้มเหลวหากเรียกใช้จากสภาพแวดล้อมของเบราว์เซอร์
ดูเอกสารโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์
ลายเซ็น:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือก Firebase | แอป Firebase | Firebase.AppOptions เพื่อกำหนดค่าบริการของแอป หรืออินสแตนซ์ FirebaseApp ที่มี AppOptions อยู่ภายใน |
การกำหนดค่า | FirebaseServerAppSettings | การกำหนดค่า FirebaseServerApp |
การคืนสินค้า:
FirebaseServerApp
เริ่มต้นแล้ว
ตัวอย่าง
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
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
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
SDK เวอร์ชันปัจจุบัน
ลายเซ็น:
SDK_VERSION: string