API dengan namespace Firebase (lama).
Fungsi
Fungsi | Keterangan |
---|---|
nama aplikasi) | |
pemeriksaan aplikasi(aplikasi) | Mendapatkan layanan AppCheck untuk aplikasi default atau aplikasi tertentu. admin.appCheck() dapat dipanggil tanpa argumen untuk mengakses layanan AppCheck aplikasi default atau sebagai admin.appCheck(app) untuk mengakses layanan AppCheck yang terkait dengan aplikasi tertentu. |
autentikasi (aplikasi) | Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu. admin.auth() dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai admin.auth(app) untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu. |
basis data (aplikasi) | Mendapatkan layanan Database untuk aplikasi default atau aplikasi tertentu. admin.database() dapat dipanggil tanpa argumen untuk mengakses layanan Database aplikasi default atau sebagai admin.database(app) untuk mengakses layanan Database yang terkait dengan aplikasi tertentu. admin.database juga merupakan namespace yang dapat digunakan untuk mengakses konstanta global dan metode yang terkait dengan layanan Database . |
toko api (aplikasi) | |
inisialisasi Aplikasi (opsi, nama) | |
instalasi (aplikasi) | Mendapatkan layanan Instalasi untuk aplikasi default atau aplikasi tertentu. admin.installations() dapat dipanggil tanpa argumen untuk mengakses layanan Instalasi aplikasi default atau sebagai admin.installations(app) untuk mengakses layanan Instalasi yang terkait dengan aplikasi tertentu. |
instanceId(aplikasi) | Mendapatkan layanan InstanceId untuk aplikasi default atau aplikasi tertentu. admin.instanceId() dapat dipanggil tanpa argumen untuk mengakses layanan InstanceId aplikasi default atau sebagai admin.instanceId(app) untuk mengakses layanan InstanceId yang terkait dengan aplikasi tertentu. |
pembelajaran mesin (aplikasi) | Mendapatkan layanan MachineLearning untuk aplikasi default atau aplikasi tertentu. admin.machineLearning() dapat dipanggil tanpa argumen untuk mengakses layanan MachineLearning aplikasi default atau sebagai admin.machineLearning(app) untuk mengakses layanan MachineLearning yang terkait dengan aplikasi tertentu. |
perpesanan (aplikasi) | Mendapatkan layanan Pesan untuk aplikasi default atau aplikasi tertentu. admin.messaging() dapat dipanggil tanpa argumen untuk mengakses layanan Messaging aplikasi default atau sebagai admin.messaging(app) untuk mengakses layanan Messaging yang terkait dengan aplikasi tertentu. |
Manajemen proyek (aplikasi) | Mendapatkan layanan ProjectManagement untuk aplikasi default atau aplikasi tertentu. admin.projectManagement() dapat dipanggil tanpa argumen untuk mengakses layanan ProjectManagement aplikasi default, atau sebagai admin.projectManagement(app) untuk mengakses layanan ProjectManagement yang terkait dengan aplikasi tertentu. |
remoteConfig(aplikasi) | Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu. admin.remoteConfig() dapat dipanggil tanpa argumen untuk mengakses layanan RemoteConfig aplikasi default atau sebagai admin.remoteConfig(app) untuk mengakses layanan RemoteConfig yang terkait dengan aplikasi tertentu. |
aturan keamanan (aplikasi) | Mendapatkan layanan SecurityRules untuk aplikasi default atau aplikasi tertentu. admin.securityRules() dapat dipanggil tanpa argumen untuk mengakses layanan SecurityRules aplikasi default, atau sebagai admin.securityRules(app) untuk mengakses layanan SecurityRules yang terkait dengan aplikasi tertentu. |
penyimpanan (aplikasi) | Mendapatkan layanan Penyimpanan untuk aplikasi default atau aplikasi tertentu. admin.storage() dapat dipanggil tanpa argumen untuk mengakses layanan Storage aplikasi default atau sebagai admin.storage(app) untuk mengakses layanan Storage yang terkait dengan aplikasi tertentu. |
Antarmuka
Antarmuka | Keterangan |
---|---|
Opsi Aplikasi | Opsi yang tersedia untuk diteruskan ke inisialisasiApp() . |
FirebaseArrayIndexError | Tipe komposit yang mencakup objek FirebaseError dan indeks yang dapat digunakan untuk mendapatkan item yang error. |
Kesalahan Firebase | FirebaseError adalah subkelas dari objek Error JavaScript standar. Selain string pesan dan pelacakan tumpukan, ini berisi kode string. |
GoogleOAuthAccessToken | Antarmuka untuk token akses Google OAuth 2.0. |
Akun Layanan |
Ruang nama
Variabel
Variabel | Keterangan |
---|---|
aplikasi | |
SDK_VERSION |
aplikasi()
Tanda tangan:
export declare function app(name?: string): app.App;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
nama | rangkaian |
Pengembalian:
pemeriksaan aplikasi()
Mendapatkan layanan AppCheck untuk aplikasi default atau aplikasi tertentu.
admin.appCheck()
dapat dipanggil tanpa argumen untuk mengakses layanan AppCheck
aplikasi default atau sebagai admin.appCheck(app)
untuk mengakses layanan AppCheck
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function appCheck(app?: App): appCheck.AppCheck;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional untuk mengembalikan layanan AppCheck . Jika tidak disediakan, layanan AppCheck default dikembalikan. |
Pengembalian:
Layanan AppCheck
default jika tidak ada aplikasi yang disediakan, atau layanan AppCheck
yang dikaitkan dengan aplikasi yang disediakan.
Contoh 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
Contoh 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
autentikasi()
Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu.
admin.auth()
dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai admin.auth(app)
untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function auth(app?: App): auth.Auth;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi |
Pengembalian:
Contoh 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
Contoh 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
basis data()
Mendapatkan layanan Database untuk aplikasi default atau aplikasi tertentu.
admin.database()
dapat dipanggil tanpa argumen untuk mengakses layanan Database
aplikasi default atau sebagai admin.database(app)
untuk mengakses layanan Database
yang terkait dengan aplikasi tertentu.
admin.database
juga merupakan namespace yang dapat digunakan untuk mengakses konstanta global dan metode yang terkait dengan layanan Database
.
Tanda tangan:
export declare function database(app?: App): database.Database;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi |
Pengembalian:
Layanan Database
default jika tidak ada aplikasi yang disediakan atau layanan Database
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
Contoh 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
toko api()
Tanda tangan:
export declare function firestore(app?: App): _firestore.Firestore;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi |
Pengembalian:
_firestore.Firestore
inisialisasi Aplikasi()
Tanda tangan:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
pilihan | Opsi Aplikasi | |
nama | rangkaian |
Pengembalian:
instalasi()
Mendapatkan layanan Instalasi untuk aplikasi default atau aplikasi tertentu.
admin.installations()
dapat dipanggil tanpa argumen untuk mengakses layanan Instalasi aplikasi default atau sebagai admin.installations(app)
untuk mengakses layanan Instalasi yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function installations(app?: App): installations.Installations;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional yang layanan Installations akan dikembalikan. Jika tidak disediakan, layanan Installations default akan dikembalikan. |
Pengembalian:
Layanan Installations
default jika tidak ada aplikasi yang disediakan atau layanan Installations
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
Contoh 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
contohId()
Mendapatkan layanan InstanceId untuk aplikasi default atau aplikasi tertentu.
admin.instanceId()
dapat dipanggil tanpa argumen untuk mengakses layanan InstanceId
aplikasi default atau sebagai admin.instanceId(app)
untuk mengakses layanan InstanceId
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function instanceId(app?: App): instanceId.InstanceId;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional yang layanan InstanceId akan dikembalikan. Jika tidak disediakan, layanan InstanceId default akan dikembalikan. |
Pengembalian:
Layanan InstanceId
default jika tidak ada aplikasi yang disediakan atau layanan InstanceId
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
Contoh 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
pembelajaran mesin()
Mendapatkan layanan MachineLearning untuk aplikasi default atau aplikasi tertentu.
admin.machineLearning()
dapat dipanggil tanpa argumen untuk mengakses layanan MachineLearning
aplikasi default atau sebagai admin.machineLearning(app)
untuk mengakses layanan MachineLearning
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional yang layanan MachineLearning akan dikembalikan. Jika tidak disediakan, layanan MachineLearning default akan dikembalikan. |
Pengembalian:
pembelajaran mesin. Pembelajaran Mesin
Layanan MachineLearning
default jika tidak ada aplikasi yang disediakan atau layanan MachineLearning
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
Contoh 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
perpesanan()
Mendapatkan layanan Pesan untuk aplikasi default atau aplikasi tertentu.
admin.messaging()
dapat dipanggil tanpa argumen untuk mengakses layanan Messaging
aplikasi default atau sebagai admin.messaging(app)
untuk mengakses layanan Messaging
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function messaging(app?: App): messaging.Messaging;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional yang layanan Messaging akan dikembalikan. Jika tidak disediakan, layanan Messaging default akan dikembalikan. |
Pengembalian:
Layanan Messaging
default jika tidak ada aplikasi yang disediakan atau layanan Messaging
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
Contoh 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
manajemen proyek()
Mendapatkan layanan ProjectManagement untuk aplikasi default atau aplikasi tertentu.
admin.projectManagement()
dapat dipanggil tanpa argumen untuk mengakses layanan ProjectManagement
aplikasi default, atau sebagai admin.projectManagement(app)
untuk mengakses layanan ProjectManagement
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional yang layanan ProjectManagement akan dikembalikan. Jika tidak disediakan, layanan ProjectManagement default akan dikembalikan. * |
Pengembalian:
Manajemen proyek.Manajemen Proyek
Layanan ProjectManagement
default jika tidak ada aplikasi yang disediakan atau layanan ProjectManagement
terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
Contoh 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
konfigurasi jarak jauh()
Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu.
admin.remoteConfig()
dapat dipanggil tanpa argumen untuk mengakses layanan RemoteConfig
aplikasi default atau sebagai admin.remoteConfig(app)
untuk mengakses layanan RemoteConfig
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional untuk mengembalikan layanan RemoteConfig . Jika tidak disediakan, layanan RemoteConfig default akan dikembalikan. |
Pengembalian:
Layanan RemoteConfig
default jika tidak ada aplikasi yang disediakan, atau layanan RemoteConfig
yang dikaitkan dengan aplikasi yang disediakan.
Contoh 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
Contoh 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
aturan keamanan()
Mendapatkan layanan SecurityRules untuk aplikasi default atau aplikasi tertentu.
admin.securityRules()
dapat dipanggil tanpa argumen untuk mengakses layanan SecurityRules aplikasi default, atau sebagai admin.securityRules(app)
untuk mengakses layanan SecurityRules yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function securityRules(app?: App): securityRules.SecurityRules;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi | Aplikasi opsional untuk mengembalikan layanan SecurityRules . Jika tidak disediakan, layanan SecurityRules default akan dikembalikan. |
Pengembalian:
aturan keamanan.aturan keamanan
Layanan SecurityRules
default jika tidak ada aplikasi yang disediakan, atau layanan SecurityRules
yang terkait dengan aplikasi yang disediakan.
Contoh 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
Contoh 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
penyimpanan()
Mendapatkan layanan Penyimpanan untuk aplikasi default atau aplikasi tertentu.
admin.storage()
dapat dipanggil tanpa argumen untuk mengakses layanan Storage
aplikasi default atau sebagai admin.storage(app)
untuk mengakses layanan Storage
yang terkait dengan aplikasi tertentu.
Tanda tangan:
export declare function storage(app?: App): storage.Storage;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi |
Pengembalian:
Contoh 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
Contoh 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
aplikasi
Tanda tangan:
apps: (app.App | null)[]
SDK_VERSION
Tanda tangan:
SDK_VERSION: string