การเริ่มต้นแอป Firebase และ SDK
ฟังก์ชัน
ฟังก์ชัน | คำอธิบาย |
---|---|
applicationDefault(httpAgent) | แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชันของ Google ที่ให้สิทธิ์เข้าถึงบริการ Firebase ในระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp()ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชันของ Google พร้อมใช้งานในโครงสร้างพื้นฐานของ Google ทั้งหมด เช่น Google App Engine และ Google Compute Engineดูรายละเอียดเพิ่มเติมได้ที่เริ่มต้น SDK |
cert(serviceAccountPathOrObject, httpAgent) | แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากบัญชีบริการที่มีให้ซึ่งให้สิทธิ์เข้าถึงบริการ Firebase ระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp() ได้ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อเริ่มต้น SDK |
deleteApp(แอป) | แสดงผลว่า App ไม่สามารถใช้งานได้ และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่างลง (แต่ *ไม่* ล้างทรัพยากรแบ็กเอนด์ใดๆ) เมื่อเรียกใช้ SDK ในเครื่อง จะต้องมีการเรียกใช้เมธอดนี้เพื่อให้แน่ใจว่ามีการสิ้นสุดกระบวนการอย่างค่อยเป็นค่อยไป |
getApp(appName) | |
getApps() | |
initializeApp(options, appName) | |
refreshToken(refreshTokenPathOrObject, httpAgent) | แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากโทเค็นการรีเฟรชที่ให้ไว้ซึ่งให้สิทธิ์เข้าถึงบริการ Firebase ในระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp() ได้ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อเริ่มต้น SDK |
คลาส
ชั้น | คำอธิบาย |
---|---|
AppErrorCodes | รหัสข้อผิดพลาดของไคลเอ็นต์แอปและข้อความเริ่มต้น |
ข้อผิดพลาดเกี่ยวกับ Firebase App | โครงสร้างรหัสข้อผิดพลาดของแอป Firebase ซึ่งจะขยายข้อผิดพลาด PrefixedFirebaseError |
อินเทอร์เฟซ
อินเทอร์เฟซ | คำอธิบาย |
---|---|
แอป | แอป Firebase มีข้อมูลการเริ่มต้นสำหรับคอลเล็กชันของบริการ |
ตัวเลือกแอป | ตัวเลือกที่พร้อมใช้งานสำหรับส่งผ่านไปยัง initializeApp() |
ข้อมูลเข้าสู่ระบบ | อินเทอร์เฟซที่ให้โทเค็นเพื่อการเข้าถึงของ Google OAuth2 ซึ่งใช้ในการตรวจสอบสิทธิ์กับบริการ Firebaseในกรณีส่วนใหญ่ คุณไม่จำเป็นต้องติดตั้งใช้งานด้วยตนเอง และสามารถใช้การใช้งานเริ่มต้นที่มาจากโมดูล firebase-admin/app แทนได้ |
ข้อผิดพลาด FirebaseArrayIndexError | ประเภทผสมซึ่งมีทั้งออบเจ็กต์ FirebaseError และดัชนีที่ใช้เพื่อรับรายการที่มีข้อผิดพลาดได้ |
ข้อผิดพลาด Firebase | FirebaseError เป็นคลาสย่อยของออบเจ็กต์ JavaScript Error มาตรฐาน นอกจากสตริงข้อความและสแต็กเทรซแล้ว ยังมีรหัสสตริงอีกด้วย |
GoogleOAuthAccessToken | อินเทอร์เฟซสำหรับโทเค็นเพื่อการเข้าถึง Google OAuth 2.0 |
บัญชีบริการ |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
SDK_VERSION |
applicationDefault(httpAgent)
แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชันของ Google ที่ให้สิทธิ์เข้าถึงบริการ Firebase ในระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp() ได้
ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชันของ Google มีอยู่ในโครงสร้างพื้นฐานทั้งหมดของ Google เช่น Google App Engine และ Google Compute Engine
ดูรายละเอียดเพิ่มเติมที่เริ่มต้น SDK
ลายเซ็น:
export declare function applicationDefault(httpAgent?: Agent): Credential;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
httpAgent | Agent | Agent ของ HTTP (ไม่บังคับ) ที่จะใช้เมื่อดึงโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ Google |
การคืนสินค้า:
ข้อมูลเข้าสู่ระบบที่ตรวจสอบสิทธิ์ผ่านข้อมูลรับรองเริ่มต้นของแอปพลิเคชันของ Google ที่ใช้เริ่มต้นแอปได้
ตัวอย่าง
initializeApp({
credential: applicationDefault(),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
cert(serviceAccountPathOrObject, httpAgent)
แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากบัญชีบริการที่มีให้ซึ่งให้สิทธิ์เข้าถึงบริการ Firebase ระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp() ได้
ดูรายละเอียดเพิ่มเติมที่เริ่มต้น SDK
ลายเซ็น:
export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
บริการเส้นทางหรือออบเจ็กต์ | สตริง | ServiceAccount | เส้นทางไปยังไฟล์ JSON ของคีย์บัญชีบริการหรือออบเจ็กต์ที่แสดงคีย์บัญชีบริการ |
httpAgent | Agent | Agent ของ HTTP (ไม่บังคับ) ที่จะใช้เมื่อดึงโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ Google |
การคืนสินค้า:
ข้อมูลเข้าสู่ระบบที่ตรวจสอบสิทธิ์ผ่านบัญชีบริการที่มีให้ซึ่งใช้ในการเริ่มต้นแอปได้
ตัวอย่าง 1
// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
credential: cert(serviceAccount),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
ตัวอย่าง 2
// Providing a service account object inline
initializeApp({
credential: cert({
projectId: "<PROJECT_ID>",
clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
}),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
DeleteApp(แอป)
แสดงผลว่า App
ไม่สามารถใช้งานได้ และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่างลง (แต่ *ไม่* ล้างทรัพยากรแบ็กเอนด์ใดๆ) เมื่อเรียกใช้ SDK ในเครื่อง จะต้องมีการเรียกใช้เมธอดนี้เพื่อให้แน่ใจว่ามีการสิ้นสุดกระบวนการอย่างค่อยเป็นค่อยไป
ลายเซ็น:
export declare function deleteApp(app: App): Promise<void>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป |
การคืนสินค้า:
คำสัญญา<void>
ตัวอย่าง
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
getApp(appName)
ลายเซ็น:
export declare function getApp(appName?: string): App;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ชื่อแอป | string |
การคืนสินค้า:
getApps()
ลายเซ็น:
export declare function getApps(): App[];
การคืนสินค้า:
แอป[]
initializeApp(options, appName)
ลายเซ็น:
export declare function initializeApp(options?: AppOptions, appName?: string): App;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือกแอป | |
ชื่อแอป | string |
การคืนสินค้า:
รีเฟรชโทเค็น(refreshTokenPathOrObject, httpAgent)
แสดงผลข้อมูลเข้าสู่ระบบที่สร้างขึ้นจากโทเค็นการรีเฟรชที่ให้ไว้ซึ่งให้สิทธิ์เข้าถึงบริการ Firebase ในระดับผู้ดูแลระบบ ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียก initializeApp() ได้
ดูรายละเอียดเพิ่มเติมที่เริ่มต้น SDK
ลายเซ็น:
export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
รีเฟรชเส้นทางหรือออบเจ็กต์ | สตริง | ออบเจ็กต์ | เส้นทางไปยังไฟล์ JSON สำหรับโทเค็นการรีเฟรชของ Google OAuth2 หรือออบเจ็กต์ที่แสดงโทเค็นการรีเฟรชของ Google OAuth2 |
httpAgent | Agent | Agent ของ HTTP (ไม่บังคับ) ที่จะใช้เมื่อดึงโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ Google |
การคืนสินค้า:
ข้อมูลเข้าสู่ระบบที่ตรวจสอบสิทธิ์ผ่านบัญชีบริการที่มีให้ซึ่งใช้ในการเริ่มต้นแอปได้
ตัวอย่าง
// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
credential: refreshToken(refreshToken),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
SDK_VERSION
ลายเซ็น:
SDK_VERSION: string