firebase-admin.app package

การเริ่มต้นแอป 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(ชื่อแอป)
getApps()
initializeApp(ตัวเลือก, appName)
refreshToken(refreshTokenPathOrObject, httpAgent)	แสดงผลข้อมูลเข้าสู่ระบบที่สร้างจากโทเค็นการรีเฟรชที่ระบุไว้ที่ให้สิทธิ์ระดับผู้ดูแลระบบในการเข้าถึงบริการ Firebase ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียกใช้ initializeApp() ได้ดูรายละเอียดเพิ่มเติมได้ที่เริ่มต้น SDK

ชั้นเรียน

ชั้น	คำอธิบาย
AppErrorCodes	รหัสข้อผิดพลาดของไคลเอ็นต์แอปและข้อความเริ่มต้น
FirebaseAppError	โครงสร้างรหัสข้อผิดพลาดของแอป Firebase ซึ่งขยาย PrefixedFirebaseError

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
แอป	แอป Firebase มีข้อมูลการเริ่มต้นสำหรับคอลเล็กชันของบริการ
ตัวเลือกแอป	ตัวเลือกที่พร้อมใช้งานเพื่อส่งไปยัง initializeApp()
ข้อมูลเข้าสู่ระบบ	อินเทอร์เฟซที่มีโทเค็นเพื่อการเข้าถึง OAuth2 ของ Google ซึ่งใช้ในการตรวจสอบสิทธิ์กับบริการ 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	HTTP Agent ที่ไม่บังคับสำหรับใช้เมื่อเรียกโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ 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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
serviceAccountPath หรือออบเจ็กต์	สตริง | บัญชีบริการ	เส้นทางไปยังไฟล์ JSON สำหรับคีย์บัญชีบริการหรือออบเจ็กต์ที่แสดงถึงคีย์บัญชีบริการ
httpAgent	Agent	HTTP Agent ที่ไม่บังคับสำหรับใช้เมื่อเรียกโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ 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"
});

ลบแอป(แอป)

แสดงผลเนื่องจาก App ไม่สามารถใช้งานได้และทำให้ทรัพยากรของบริการที่เกี่ยวข้องทั้งหมดว่าง (แต่จะ *ไม่* ล้างทรัพยากรแบ็กเอนด์ใดๆ) เมื่อเรียกใช้ SDK ในเครื่อง ต้องเรียกใช้เมธอดนี้เพื่อให้แน่ใจว่ากระบวนการสิ้นสุดได้อย่างราบรื่น

ลายเซ็น:

export declare function deleteApp(app: App): Promise<void>;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป

การคืนสินค้า:

คำสัญญา<โมฆะ>

ตัวอย่าง

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(ชื่อแอป)

ลายเซ็น:

export declare function getApp(appName?: string): App;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ชื่อแอป	สตริง

การคืนสินค้า:

แอป

getApps()

ลายเซ็น:

export declare function getApps(): App[];

การคืนสินค้า:

แอป[]

defaultizeApp(ตัวเลือก, appName)

ลายเซ็น:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือก	ตัวเลือกแอป
ชื่อแอป	สตริง

การคืนสินค้า:

แอป

RefreshToken(refreshTokenPathOrObject, httpAgent)

แสดงผลข้อมูลเข้าสู่ระบบที่สร้างจากโทเค็นการรีเฟรชที่ระบุไว้ที่ให้สิทธิ์ระดับผู้ดูแลระบบในการเข้าถึงบริการ Firebase ข้อมูลเข้าสู่ระบบนี้สามารถใช้ในการเรียกใช้ initializeApp() ได้

ดูรายละเอียดเพิ่มเติมได้ที่เริ่มต้น SDK

ลายเซ็น:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
RefreshTokenPathOrObject	สตริง | ออบเจ็กต์	เส้นทางไปยังไฟล์ JSON ของโทเค็นการรีเฟรช OAuth2 ของ Google หรือออบเจ็กต์ที่แสดงถึงโทเค็นการรีเฟรช OAuth2 ของ Google
httpAgent	Agent	HTTP Agent ที่ไม่บังคับสำหรับใช้เมื่อเรียกโทเค็นเพื่อการเข้าถึงจากเซิร์ฟเวอร์โทเค็นของ 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