Namespaced API ของ Firebase (เดิม)
ฟังก์ชัน
ฟังก์ชัน | คำอธิบาย |
---|---|
แอป(name) | |
appCheck(แอป) | รับบริการ AppCheck สำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.appCheck() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ AppCheck ของแอปเริ่มต้น หรือโดยใช้ admin.appCheck(app) เพื่อเข้าถึงบริการของ AppCheck ที่เชื่อมโยงกับแอปใดแอปหนึ่ง |
auth(แอป) | รับบริการ Auth สำหรับแอปเริ่มต้นหรือแอปหนึ่งๆ admin.auth() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Auth ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.auth(app) เพื่อเข้าถึงบริการ Auth ที่เชื่อมโยงกับแอปนั้นๆ ได้ |
ฐานข้อมูล(แอป) | รับบริการฐานข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.database() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Database ของแอปเริ่มต้น หรือโดยใช้ admin.database(app) เพื่อเข้าถึงบริการ Database ที่เชื่อมโยงกับแอปเฉพาะadmin.database เป็นเนมสเปซที่ใช้เข้าถึงค่าคงที่และเมธอดส่วนกลางที่เชื่อมโยงกับบริการ Database ได้ด้วย |
firestore(แอป) | |
เริ่มต้นแอป(ตัวเลือก ชื่อ) | |
การติดตั้ง(แอป) | รับบริการการติดตั้งสำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.installations() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการการติดตั้งของแอปเริ่มต้น หรือโดยใช้ admin.installations(app) เพื่อเข้าถึงบริการการติดตั้งที่เชื่อมโยงกับแอปบางแอป |
อินสแตนซ์(แอป) | รับบริการ InstanceId สำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.instanceId() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ InstanceId ของแอปเริ่มต้น หรือโดยใช้ admin.instanceId(app) เพื่อเข้าถึงบริการของ InstanceId ที่เชื่อมโยงกับแอปบางแอป |
machineLearning(แอป) | รับบริการ MachineLearning สำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.machineLearning() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ MachineLearning ของแอปเริ่มต้น หรือโดยใช้ admin.machineLearning(app) เพื่อเข้าถึงบริการของ MachineLearning ที่เชื่อมโยงกับแอปบางแอป |
การรับส่งข้อความ(แอป) | รับบริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.messaging() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้น หรือโดยใช้ admin.messaging(app) เพื่อเข้าถึงบริการของ Messaging ที่เชื่อมโยงกับแอปใดแอปหนึ่ง |
projectManagement(แอป) | รับบริการการจัดการโครงการสำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.projectManagement() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ ProjectManagement ของแอปเริ่มต้น หรือโดยใช้ admin.projectManagement(app) เพื่อเข้าถึงบริการของ ProjectManagement ที่เชื่อมโยงกับแอปใดแอปหนึ่ง |
remoteConfig(แอป) | รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.remoteConfig() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ RemoteConfig ของแอปเริ่มต้น หรือเรียกเป็น admin.remoteConfig(app) เพื่อเข้าถึงบริการของ RemoteConfig ที่เชื่อมโยงกับแอปบางแอป |
security Rules(แอป) | รับบริการ Security Rules สำหรับแอปเริ่มต้นหรือแอปที่กำหนดadmin.securityRules() สามารถเรียกใช้ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Security Rules เริ่มต้นของแอป หรือเรียกใช้เป็น admin.securityRules(app) เพื่อเข้าถึงบริการ Security Rules ที่เชื่อมโยงกับแอปบางแอปได้ |
storage(แอป) | รับบริการพื้นที่เก็บข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.storage() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Storage ของแอปเริ่มต้น หรือโดยใช้ admin.storage(app) เพื่อเข้าถึงบริการของ Storage ที่เชื่อมโยงกับแอปบางแอป |
อินเทอร์เฟซ
อินเทอร์เฟซ | คำอธิบาย |
---|---|
ตัวเลือกแอป | ตัวเลือกที่พร้อมใช้งานสำหรับส่งผ่านไปยัง initializeApp() |
ข้อผิดพลาด FirebaseArrayIndexError | ประเภทผสมซึ่งมีทั้งออบเจ็กต์ FirebaseError และดัชนีที่ใช้เพื่อรับรายการที่มีข้อผิดพลาดได้ |
ข้อผิดพลาด Firebase | FirebaseError เป็นคลาสย่อยของออบเจ็กต์ JavaScript Error มาตรฐาน นอกจากสตริงข้อความและสแต็กเทรซแล้ว ยังมีรหัสสตริงอีกด้วย |
GoogleOAuthAccessToken | อินเทอร์เฟซสำหรับโทเค็นเพื่อการเข้าถึง Google OAuth 2.0 |
บัญชีบริการ |
เนมสเปซ
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
แอป | |
SDK_VERSION |
แอป(ชื่อ)
ลายเซ็น:
export declare function app(name?: string): app.App;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
name | string |
การคืนสินค้า:
appCheck(แอป)
รับบริการ AppCheck สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.appCheck()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ AppCheck
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.appCheck(app)
เพื่อเข้าถึงบริการของ AppCheck
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function appCheck(app?: App): appCheck.AppCheck;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปที่ไม่บังคับสำหรับส่งคืนบริการของ AppCheck หากไม่ระบุ ระบบจะส่งคืนบริการ AppCheck เริ่มต้น |
การคืนสินค้า:
บริการ AppCheck
เริ่มต้นหากไม่มีการให้แอป หรือบริการ AppCheck
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
ตัวอย่าง 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
auth(แอป)
รับบริการการตรวจสอบสิทธิ์สำหรับแอปเริ่มต้นหรือแอปที่ระบุ
สามารถเรียก admin.auth()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Auth ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.auth(app)
เพื่อเข้าถึงบริการ Auth ที่เชื่อมโยงกับแอปนั้นๆ ได้
ลายเซ็น:
export declare function auth(app?: App): auth.Auth;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป |
การคืนสินค้า:
ตัวอย่าง 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
ตัวอย่าง 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
ฐานข้อมูล(แอป)
รับบริการฐานข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่ระบุ
สามารถเรียก admin.database()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Database
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.database(app)
เพื่อเข้าถึงบริการของ Database
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
admin.database
เป็นเนมสเปซที่ใช้เพื่อเข้าถึงค่าคงที่และเมธอดทั่วโลกที่เชื่อมโยงกับบริการ Database
ได้
ลายเซ็น:
export declare function database(app?: App): database.Database;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป |
การคืนสินค้า:
บริการ Database
เริ่มต้นหากไม่มีการให้แอป หรือบริการ Database
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
ตัวอย่าง 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
Firestore(แอป)
ลายเซ็น:
export declare function firestore(app?: App): _firestore.Firestore;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป |
การคืนสินค้า:
_firestore.Firestore
เริ่มต้นแอป(ตัวเลือก, ชื่อ)
ลายเซ็น:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ตัวเลือก | ตัวเลือกแอป | |
name | string |
การคืนสินค้า:
การติดตั้ง(แอป)
รับบริการการติดตั้งสำหรับแอปเริ่มต้นหรือแอปที่ระบุ
สามารถเรียก admin.installations()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการการติดตั้งของแอปเริ่มต้น หรือโดยใช้ admin.installations(app)
เพื่อเข้าถึงบริการการติดตั้งที่เชื่อมโยงกับแอปใดแอปหนึ่ง
ลายเซ็น:
export declare function installations(app?: App): installations.Installations;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปเสริมที่มีบริการ Installations ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ Installations เริ่มต้น |
การคืนสินค้า:
บริการ Installations
เริ่มต้นหากไม่มีการให้แอป หรือบริการ Installations
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
ตัวอย่าง 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
รหัสอินสแตนซ์(แอป)
รับบริการ InstanceId สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.instanceId()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ InstanceId
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.instanceId(app)
เพื่อเข้าถึงบริการของ InstanceId
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function instanceId(app?: App): instanceId.InstanceId;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปเสริมที่มีบริการ InstanceId ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ InstanceId เริ่มต้น |
การคืนสินค้า:
บริการ InstanceId
เริ่มต้นหากไม่มีการให้แอป หรือบริการ InstanceId
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
ตัวอย่าง 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
MachineLearning(แอป)
รับบริการ MachineLearning สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.machineLearning()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ MachineLearning
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.machineLearning(app)
เพื่อเข้าถึงบริการของ MachineLearning
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปเสริมที่มีบริการ MachineLearning ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ MachineLearning เริ่มต้น |
การคืนสินค้า:
machineLearning.MachineLearning
บริการ MachineLearning
เริ่มต้นหากไม่มีการให้แอป หรือบริการ MachineLearning
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
ตัวอย่าง 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
การรับส่งข้อความ(แอป)
ใช้บริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.messaging()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.messaging(app)
เพื่อเข้าถึงบริการของ Messaging
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function messaging(app?: App): messaging.Messaging;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปเสริมที่มีบริการ Messaging ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ Messaging เริ่มต้น |
การคืนสินค้า:
บริการ Messaging
เริ่มต้นหากไม่มีการให้แอป หรือบริการ Messaging
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
ตัวอย่าง 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
การจัดการโปรเจ็กต์(แอป)
รับบริการการจัดการโครงการสำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียกใช้ admin.projectManagement()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ ProjectManagement
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.projectManagement(app)
เพื่อเข้าถึงบริการของ ProjectManagement
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปเสริมที่มีบริการ ProjectManagement ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ ProjectManagement เริ่มต้น * |
การคืนสินค้า:
projectManagement.ProjectManagement
บริการ ProjectManagement
เริ่มต้นหากไม่มีการให้แอป หรือบริการ ProjectManagement
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
ตัวอย่าง 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
RemoteConfig(แอป)
รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.remoteConfig()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ RemoteConfig
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.remoteConfig(app)
เพื่อเข้าถึงบริการของ RemoteConfig
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปที่ไม่บังคับสำหรับส่งคืนบริการของ RemoteConfig หากไม่ระบุ ระบบจะส่งคืนบริการ RemoteConfig เริ่มต้น |
การคืนสินค้า:
บริการ RemoteConfig
เริ่มต้นหากไม่มีการให้แอป หรือบริการ RemoteConfig
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
ตัวอย่าง 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
SecurityRule(แอป)
รับบริการ SecurityRule สำหรับแอปเริ่มต้นหรือแอปที่กำหนด
เรียกใช้ admin.securityRules()
ได้โดยไม่ต้องมีอาร์กิวเมนต์ เพื่อเข้าถึงบริการ SecurityRULE ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.securityRules(app)
เพื่อเข้าถึงบริการ Security Rules ที่เชื่อมโยงกับแอปใดแอปหนึ่งได้
ลายเซ็น:
export declare function securityRules(app?: App): securityRules.SecurityRules;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป | แอปที่ไม่บังคับสำหรับส่งคืนบริการ SecurityRules หากไม่ระบุ ระบบจะส่งคืนบริการ SecurityRules เริ่มต้น |
การคืนสินค้า:
บริการ SecurityRules
เริ่มต้นหากไม่มีการให้แอป หรือบริการ SecurityRules
ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
ตัวอย่าง 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
พื้นที่เก็บข้อมูล(แอป)
ใช้บริการพื้นที่เก็บข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียก admin.storage()
โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Storage
ของแอปเริ่มต้น หรือเรียกใช้เป็น admin.storage(app)
เพื่อเข้าถึงบริการของ Storage
ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ
ลายเซ็น:
export declare function storage(app?: App): storage.Storage;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป |
การคืนสินค้า:
ตัวอย่าง 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
ตัวอย่าง 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
แอป
ลายเซ็น:
apps: (app.App | null)[]
SDK_VERSION
ลายเซ็น:
SDK_VERSION: string