Firebase Installations Web SDK. SDK ini tidak berfungsi di lingkungan Node.js.
Functions
Fungsi | Deskripsi |
---|---|
fungsi(aplikasi, ...) | |
getInstallations(aplikasi) | Menampilkan instance Penginstalan yang terkait dengan instance FirebaseApp tertentu. |
function(penginstalan, ...) | |
deleteInstallations(penginstalan) | Menghapus Penginstalan Firebase dan semua data terkait. |
getId(penginstalan) | Membuat Penginstalan Firebase jika tidak ada untuk aplikasi dan menampilkan ID Penginstalan. |
getToken(penginstalan, forceRefresh) | Menampilkan token autentikasi Penginstalan Firebase, yang mengidentifikasi Penginstalan Firebase saat ini. |
onIdChange(penginstalan, callback) | Menetapkan callback baru yang akan dipanggil saat ID Penginstalan berubah. Menampilkan fungsi berhenti berlangganan yang akan menghapus callback saat dipanggil. |
Antarmuka
Antarmuka | Deskripsi |
---|---|
Penginstalan | Antarmuka publik Firebase Installations SDK. |
Ketik Alias
Ketik Alias | Deskripsi |
---|---|
IdChangeCallbackFn | Fungsi callback buatan pengguna yang akan dipanggil saat ID Penginstalan berubah. |
IdChangeUnsubscribeFn | Berhenti berlangganan fungsi callback yang sebelumnya ditambahkan melalui IdChangeCallbackFn. |
function(aplikasi, ...)
getInstallations(aplikasi)
Menampilkan instance Penginstalan yang terkait dengan instance FirebaseApp tertentu.
Tanda Tangan:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
aplikasi | AplikasiFirebase | Instance FirebaseApp. |
Hasil:
function(penginstalan, ...)
deleteInstallations(penginstalan)
Menghapus Penginstalan Firebase dan semua data terkait.
Tanda Tangan:
export declare function deleteInstallations(installations: Installations): Promise<void>;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
penginstalan | Penginstalan | Instance Installations . |
Hasil:
Janji<void>
getId(penginstalan)
Membuat Penginstalan Firebase jika tidak ada untuk aplikasi dan menampilkan ID Penginstalan.
Tanda Tangan:
export declare function getId(installations: Installations): Promise<string>;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
penginstalan | Penginstalan | Instance Installations . |
Hasil:
Promise<string>
getToken(penginstalan, forceRefresh)
Menampilkan token autentikasi Penginstalan Firebase, yang mengidentifikasi Penginstalan Firebase saat ini.
Tanda Tangan:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
penginstalan | Penginstalan | Instance Installations . |
muat ulang paksa | boolean | Muat ulang paksa terlepas dari masa berlaku token. |
Hasil:
Promise<string>
onIdChange(penginstalan, callback)
Menetapkan callback baru yang akan dipanggil saat ID Penginstalan berubah. Menampilkan fungsi berhenti berlangganan yang akan menghapus callback saat dipanggil.
Tanda Tangan:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Parameter
Parameter | Jenis | Deskripsi |
---|---|---|
penginstalan | Penginstalan | Instance Installations . |
callback | IdChangeCallbackFn | Fungsi callback yang dipanggil saat FID berubah. |
Hasil:
Fungsi yang dapat dipanggil untuk berhenti berlangganan.
IdChangeCallbackFn
Fungsi callback buatan pengguna yang akan dipanggil saat ID Penginstalan berubah.
Tanda Tangan:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeUnsubscribeFn
Berhenti berlangganan fungsi callback yang sebelumnya ditambahkan melalui IdChangeCallbackFn.
Tanda Tangan:
export declare type IdChangeUnsubscribeFn = () => void;