installations package

Firebase Yüklemeler Web SDK'sı. Bu SDK, Node.js ortamında çalışmaz.

İşlevler

İşlev Açıklama
fonksiyon(uygulama, ...)
getINSTALLs(uygulama) Belirtilen FirebaseApp örneğiyle ilişkilendirilmiş INSTALLs örneğini döndürür.
fonksiyon(kurulumlar, ...)
deleteINSTALLs(installations) Firebase Yüklemesini ve ilişkili tüm verileri siler.
getId(yüklemeler) Uygulama için yoksa Firebase yüklemesi oluşturur ve yükleme kimliğini döndürür.
getToken(yüklemeler, forceRefresh) Mevcut Firebase Yüklemesini tanımlayan bir Firebase Yüklemeler kimlik doğrulama jetonu döndürür.
onIdChange(yüklemeler, geri çağırma) Kurulum Kimliği değiştiğinde çağrılacak yeni bir geri çağırma ayarlar. Çağrı yapıldığında geri çağırmayı kaldıracak bir aboneliği iptal etme işlevi döndürür.

Arayüzler

Arayüz Açıklama
Yüklemeler Firebase Yüklemeler SDK'sının herkese açık arayüzü.

Tür Takma Adları

Takma Ad yazın Açıklama
IdChangeCallbackFn Kurulum Kimliği değiştiğinde çağrılan, kullanıcı tanımlı bir geri çağırma işlevi.
IdChangeUnsubscribeFn Daha önce IdChangeCallbackFn aracılığıyla eklenen bir geri çağırma işlevinin aboneliğinden çıkın.

function(uygulama; ...)

getINSTALLs(uygulama)

Belirtilen FirebaseApp örneğiyle ilişkilendirilmiş INSTALLs örneğini döndürür.

İmza:

export declare function getInstallations(app?: FirebaseApp): Installations;

Parametreler

Parametre Tür Açıklama
uygulama FirebaseUygulaması FirebaseApp örneği.

Şunu döndürür:

Yüklemeler

function(kurulumlar, ...)

deleteINSTALLs(yüklemeler)

Firebase Yüklemesini ve ilişkili tüm verileri siler.

İmza:

export declare function deleteInstallations(installations: Installations): Promise<void>;

Parametreler

Parametre Tür Açıklama
yüklemeler Yüklemeler Installations örneği.

Şunu döndürür:

Taahhüt<void>

getId(yüklemeler)

Uygulama için yoksa Firebase yüklemesi oluşturur ve yükleme kimliğini döndürür.

İmza:

export declare function getId(installations: Installations): Promise<string>;

Parametreler

Parametre Tür Açıklama
yüklemeler Yüklemeler Installations örneği.

Şunu döndürür:

Promise<dize>

getToken(yüklemeler, forceRefresh)

Mevcut Firebase Yüklemesini tanımlayan bir Firebase Yüklemeler kimlik doğrulama jetonu döndürür.

İmza:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

Parametreler

Parametre Tür Açıklama
yüklemeler Yüklemeler Installations örneği.
zorla yenileme boolean Jetonun geçerlilik süresi ne olursa olsun zorunlu yenileme.

Şunu döndürür:

Promise<dize>

onIdChange(yüklemeler, geri çağırma)

Kurulum Kimliği değiştiğinde çağrılacak yeni bir geri çağırma ayarlar. Çağrı yapıldığında geri çağırmayı kaldıracak bir aboneliği iptal etme işlevi döndürür.

İmza:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

Parametreler

Parametre Tür Açıklama
yüklemeler Yüklemeler Installations örneği.
geri çağırma IdChangeCallbackFn İGG değiştiğinde çağrılan geri çağırma işlevi.

Şunu döndürür:

IdChangeUnsubscribeFn

Abonelikten çıkmak için çağrılabilen bir işlev.

IdChangeCallbackFn

Kurulum Kimliği değiştiğinde çağrılan, kullanıcı tanımlı bir geri çağırma işlevi.

İmza:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeUnsubscribeFn

Daha önce IdChangeCallbackFn aracılığıyla eklenen bir geri çağırma işlevinin aboneliğinden çıkın.

İmza:

export declare type IdChangeUnsubscribeFn = () => void;