SDK Web Penginstalan Firebase. SDK ini tidak berfungsi di lingkungan Node.js.
Fungsi
Fungsi | Keterangan |
---|---|
fungsi(aplikasi, ...) | |
dapatkan Instalasi (aplikasi) | Mengembalikan instance Instalasi yang terkait dengan instance FirebaseApp yang diberikan. |
fungsi (instalasi, ...) | |
hapusInstalasi(instalasi) | Menghapus Instalasi Firebase dan semua data terkait. |
getId(instalasi) | Membuat Penginstalan Firebase jika tidak ada untuk aplikasi dan mengembalikan ID Penginstalan. |
getToken(instalasi, forceRefresh) | Mengembalikan token autentikasi Instalasi Firebase, yang mengidentifikasi Instalasi Firebase saat ini. |
onIdChange(instalasi, panggilan balik) | Menetapkan panggilan balik baru yang akan dipanggil ketika ID Instalasi berubah. Mengembalikan fungsi berhenti berlangganan yang akan menghapus panggilan balik saat dipanggil. |
Antarmuka
Antarmuka | Keterangan |
---|---|
Instalasi | Antarmuka publik SDK Instalasi Firebase. |
Ketik Alias
Ketik Alias | Keterangan |
---|---|
IdChangeCallbackFn | Fungsi panggilan balik yang ditentukan pengguna yang dipanggil ketika ID Instalasi berubah. |
IdChangeBerhenti BerlanggananFn | Berhenti berlangganan fungsi panggilan balik yang sebelumnya ditambahkan melalui IdChangeCallbackFn . |
fungsi(aplikasi, ...)
dapatkan Instalasi (aplikasi)
Mengembalikan instance Instalasi yang terkait dengan instance FirebaseApp yang diberikan.
Tanda tangan:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi Firebase | Contoh FirebaseApp . |
Pengembalian:
fungsi (instalasi, ...)
hapusInstalasi(instalasi)
Menghapus Instalasi Firebase dan semua data terkait.
Tanda tangan:
export declare function deleteInstallations(installations: Installations): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
instalasi | Instalasi | Contoh Installations . |
Pengembalian:
Janji<batal>
getId(instalasi)
Membuat Penginstalan Firebase jika tidak ada untuk aplikasi dan mengembalikan ID Penginstalan.
Tanda tangan:
export declare function getId(installations: Installations): Promise<string>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
instalasi | Instalasi | Contoh Installations . |
Pengembalian:
Janji<string>
getToken(instalasi, forceRefresh)
Mengembalikan token autentikasi Instalasi Firebase, yang mengidentifikasi Instalasi Firebase saat ini.
Tanda tangan:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
instalasi | Instalasi | Contoh Installations . |
forceRefresh | boolean | Paksa penyegaran terlepas dari masa berlaku token. |
Pengembalian:
Janji<string>
onIdChange(instalasi, panggilan balik)
Menetapkan panggilan balik baru yang akan dipanggil ketika ID Instalasi berubah. Mengembalikan fungsi berhenti berlangganan yang akan menghapus panggilan balik saat dipanggil.
Tanda tangan:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
instalasi | Instalasi | Contoh Installations . |
panggilan balik | IdChangeCallbackFn | Fungsi panggilan balik yang dipanggil ketika FID berubah. |
Pengembalian:
IdChangeBerhenti BerlanggananFn
Sebuah fungsi yang dapat dipanggil untuk berhenti berlangganan.
IdChangeCallbackFn
Fungsi panggilan balik yang ditentukan pengguna yang dipanggil ketika ID Instalasi berubah.
Tanda tangan:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeBerhenti BerlanggananFn
Berhenti berlangganan fungsi panggilan balik yang sebelumnya ditambahkan melalui IdChangeCallbackFn .
Tanda tangan:
export declare type IdChangeUnsubscribeFn = () => void;