แอป Firebase
แพ็กเกจนี้จะประสานการสื่อสารระหว่างคอมโพเนนต์ Firebase ที่แตกต่างกัน
ฟังก์ชัน
การทำงาน | คำอธิบาย |
---|---|
ฟังก์ชัน(แอป, ...) | |
deleteApp(แอป) | แสดงผลแอปนี้ไม่สามารถใช้งานได้ และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่างลง |
function() | |
getApps() | อาร์เรย์ (อ่านอย่างเดียว) ของแอปที่เริ่มต้นทั้งหมด |
initializeApp() | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, version, variant) | ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม |
function(logCallback, ...) | |
onLog(logCallback, ตัวเลือก) | ตั้งค่าเครื่องจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด |
function(logLevel, ...) | |
setLogLevel(logLevel) | ตั้งค่าระดับการบันทึกสำหรับ Firebase SDK ทั้งหมดระบบจะเก็บบันทึกทุกประเภทที่อยู่เหนือระดับการบันทึกปัจจุบัน (กล่าวคือ หากคุณตั้งค่าระดับการบันทึกเป็น info ระบบจะบันทึกข้อผิดพลาด แต่ไม่บันทึก debug และ verbose ) |
ฟังก์ชัน(ชื่อ, ...) | |
getApp(name) | เรียกอินสแตนซ์ FirebaseAppเมื่อเรียกใช้โดยไม่มีอาร์กิวเมนต์ ระบบจะแสดงผลแอปเริ่มต้น เมื่อระบุชื่อแอปแล้ว ระบบจะแสดงผลแอปที่ตรงกับชื่อนั้นระบบจะมีข้อยกเว้นหากแอปที่ดึงข้อมูลนั้นยังไม่ได้เริ่มต้น |
ฟังก์ชัน(ตัวเลือก, ...) | |
เริ่มต้นแอป(ตัวเลือก ชื่อ) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseAppโปรดดูเอกสารประกอบโดยละเอียดที่เพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์ |
เริ่มต้นแอป(ตัวเลือก การกำหนดค่า) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp |
initializeServerApp(options, การกำหนดค่า) | สร้างและเริ่มต้นอินสแตนซ์ FirebaseServerAppFirebaseServerApp นั้นคล้ายกับ FirebaseApp แต่มีไว้สำหรับการดำเนินการในสภาพแวดล้อมการแสดงผลฝั่งเซิร์ฟเวอร์เท่านั้น การเริ่มต้นจะไม่สำเร็จหากเรียกใช้จากสภาพแวดล้อมของเบราว์เซอร์โปรดดูเอกสารประกอบโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปของคุณและเริ่มต้นหลายโปรเจ็กต์ |
อินเทอร์เฟซ
SDK โฆษณา B | คำอธิบาย |
---|---|
FirebaseApp | FirebaseApp มีข้อมูลการเริ่มต้นสำหรับคอลเล็กชันบริการโปรดอย่าเรียกใช้ตัวสร้างนี้โดยตรง แต่ให้ใช้ initializeApp() เพื่อสร้างแอปแทน |
FirebaseAppSettings | ตัวเลือกการกำหนดค่าที่กำหนดให้กับ initializeApp() |
FirebaseOptions | ออบเจ็กต์การกำหนดค่า Firebase มีชุดพารามิเตอร์ที่บริการต้องใช้เพื่อให้สื่อสารกับ API ของเซิร์ฟเวอร์ Firebase และเชื่อมโยงข้อมูลไคลเอ็นต์กับโปรเจ็กต์ Firebase และแอปพลิเคชัน Firebase ได้สำเร็จ โดยปกติแล้ว ออบเจ็กต์นี้จะสร้างขึ้นโดยคอนโซล Firebase ในขั้นตอนการตั้งค่าโปรเจ็กต์ ดูข้อมูลเพิ่มเติมที่หัวข้อดูข้อมูลเกี่ยวกับออบเจ็กต์การกำหนดค่า Firebase |
FirebaseServerApp | FirebaseServerApp มีข้อมูลการเริ่มต้นสำหรับคอลเล็กชันของบริการที่ทำงานในสภาพแวดล้อมของเซิร์ฟเวอร์โปรดอย่าเรียกใช้ตัวสร้างนี้โดยตรง แต่ให้ใช้ initializeServerApp() เพื่อสร้างแอปแทน |
FirebaseServerAppSettings | ตัวเลือกการกำหนดค่าที่กำหนดให้กับ initializeServerApp() |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
SDK_VERSION | SDK เวอร์ชันปัจจุบัน |
ฟังก์ชัน(แอป, ...)
DeleteApp(แอป)
แสดงผลแอปนี้ไม่สามารถใช้งานได้ และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่างลง
ลายเซ็น:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | FirebaseApp |
การคืนสินค้า:
Promise<void>
ตัวอย่าง
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
ฟังก์ชัน()
getApps()
อาร์เรย์ (อ่านอย่างเดียว) ของแอปที่เริ่มต้นทั้งหมด
ลายเซ็น:
export declare function getApps(): FirebaseApp[];
การคืนสินค้า:
initializeApp()
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ลายเซ็น:
export declare function initializeApp(): FirebaseApp;
การคืนสินค้า:
ฟังก์ชัน(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
ลงทะเบียนชื่อและเวอร์ชันของไลบรารีเพื่อวัตถุประสงค์ในการบันทึกแพลตฟอร์ม
ลายเซ็น:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
libraryKeyOrName | string | |
เวอร์ชัน | string | เวอร์ชันปัจจุบันของไลบรารีดังกล่าว |
variant | string | ตัวแปรของแพ็กเกจ เช่น โหนด, rn ฯลฯ |
การคืนสินค้า:
void
ฟังก์ชัน(logCallback, ...)
onLog(logCallback, ตัวเลือก)
ตั้งค่าเครื่องจัดการบันทึกสำหรับ Firebase SDK ทั้งหมด
ลายเซ็น:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
logCallback | LogCallback | null | เครื่องจัดการบันทึกที่กำหนดเองซึ่งไม่บังคับซึ่งจะเรียกใช้รหัสผู้ใช้ทุกครั้งที่ Firebase SDK ทำการเรียกใช้การบันทึก |
ตัวเลือก | LogOptions |
การคืนสินค้า:
void
ฟังก์ชัน(logLevel, ...)
setLogLevel(logLevel)
ตั้งค่าระดับการบันทึกสำหรับ Firebase SDK ทั้งหมด
ระบบจะบันทึกประเภทบันทึกทั้งหมดที่อยู่เหนือระดับการบันทึกปัจจุบัน (กล่าวคือ หากคุณตั้งค่าระดับการบันทึกเป็น info
ระบบจะบันทึกข้อผิดพลาดไว้ แต่ไม่บันทึก debug
และ verbose
)
ลายเซ็น:
export declare function setLogLevel(logLevel: LogLevelString): void;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
logLevel | LogLevelString |
การคืนสินค้า:
void
ฟังก์ชัน(ชื่อ, ...)
getApp(name)
เรียกอินสแตนซ์ FirebaseApp
เมื่อเรียกใช้โดยไม่มีอาร์กิวเมนต์ ระบบจะแสดงผลแอปเริ่มต้น เมื่อระบุชื่อแอปแล้ว ระบบจะแสดงแอปที่ตรงกับชื่อนั้น
จะมีข้อยกเว้นหากแอปที่เรียกดูนั้นยังไม่ได้เริ่มต้น
ลายเซ็น:
export declare function getApp(name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ชื่อ | string | ชื่อแอปที่ไม่บังคับที่จะส่งคืน หากไม่ได้ระบุชื่อไว้ ระบบจะใช้ค่าเริ่มต้น "[DEFAULT]" |
การคืนสินค้า:
แอปที่สอดคล้องกับชื่อแอปที่ระบุ หากไม่ได้ระบุชื่อแอปไว้ ระบบจะแสดงผลแอปเริ่มต้น
ตัวอย่างที่ 1
// Return the default app
const app = getApp();
ตัวอย่างที่ 2
// Return a named app
const otherApp = getApp("otherApp");
ฟังก์ชัน(ตัวเลือก, ...)
เริ่มต้นแอป(ตัวเลือก, ชื่อ)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseApp
ดูเอกสารประกอบโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์
ลายเซ็น:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | FirebaseOptions | ตัวเลือกในการกำหนดค่าบริการของแอป |
ชื่อ | string | ชื่อเพิ่มเติมของแอปที่จะเริ่มต้น หากไม่ได้ระบุชื่อไว้ ระบบจะใช้ค่าเริ่มต้น "[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;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | FirebaseOptions | ตัวเลือกในการกำหนดค่าบริการของแอป |
การกำหนดค่า | FirebaseAppSettings | การกำหนดค่า FirebaseApp |
การคืนสินค้า:
initializeServerApp(options, config)
สร้างและเริ่มต้นอินสแตนซ์ FirebaseServerApp
FirebaseServerApp
คล้ายกับ FirebaseApp
แต่มีไว้สำหรับการดำเนินการในสภาพแวดล้อมการแสดงผลฝั่งเซิร์ฟเวอร์เท่านั้น การเริ่มต้นจะล้มเหลวหากเรียกใช้จากสภาพแวดล้อมของเบราว์เซอร์
ดูเอกสารประกอบโดยละเอียดที่หัวข้อเพิ่ม Firebase ลงในแอปและเริ่มต้นหลายโปรเจ็กต์
ลายเซ็น:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | FirebaseOptions | FirebaseApp | 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