Веб-SDK для установки Firebase. Этот SDK не работает в среде Node.js.
Функции
| Функция | Описание |
|---|---|
| функция (приложение, ...) | |
| getInstallations (приложение) | Возвращает экземпляр установок , связанный с данным экземпляром FirebaseApp . |
| функция(установки, ...) | |
| deleteInstallations(установки) | Удаляет установку Firebase и все связанные данные. |
| getId(установки) | Создает установку Firebase, если для приложения ее нет, и возвращает идентификатор установки. |
| getToken (установки, принудительное обновление) | Возвращает токен аутентификации Firebase Installations, идентифицирующий текущую установку Firebase. |
| onIdChange (установки, обратный вызов) | Устанавливает новый обратный вызов, который будет вызываться при изменении идентификатора установки. Возвращает функцию отмены подписки, которая удалит обратный вызов при вызове. |
Интерфейсы
| Интерфейс | Описание |
|---|---|
| Инсталляции | Открытый интерфейс Firebase Installations SDK. |
Введите псевдонимы
| Введите псевдоним | Описание |
|---|---|
| IdChangeCallbackFn | Определенная пользователем функция обратного вызова, которая вызывается при изменении идентификатора установки. |
| IdChangeОтписатьсяFn | Отменить подписку на функцию обратного вызова, ранее добавленную через IdChangeCallbackFn . . |
функция (приложение, ...)
getInstallations (приложение)
Возвращает экземпляр установок , связанный с данным экземпляром FirebaseApp .
Подпись:
export declare function getInstallations(app?: FirebaseApp): Installations;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| приложение | FirebaseApp | Экземпляр FirebaseApp . |
Возврат:
функция(установки, ...)
deleteInstallations(установки)
Удаляет установку Firebase и все связанные данные.
Подпись:
export declare function deleteInstallations(installations: Installations): Promise<void>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| установки | Инсталляции | Экземпляр Installations . |
Возврат:
Обещание<void>
getId(установки)
Создает установку Firebase, если для приложения ее нет, и возвращает идентификатор установки.
Подпись:
export declare function getId(installations: Installations): Promise<string>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| установки | Инсталляции | Экземпляр Installations . |
Возврат:
Обещание<строка>
getToken (установки, принудительное обновление)
Возвращает токен аутентификации Firebase Installations, идентифицирующий текущую установку Firebase.
Подпись:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| установки | Инсталляции | Экземпляр Installations . |
| принудительное обновление | логическое значение | Принудительное обновление независимо от истечения срока действия токена. |
Возврат:
Обещание<строка>
onIdChange (установки, обратный вызов)
Устанавливает новый обратный вызов, который будет вызываться при изменении идентификатора установки. Возвращает функцию отмены подписки, которая удалит обратный вызов при вызове.
Подпись:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| установки | Инсталляции | Экземпляр Installations . |
| перезвонить | IdChangeCallbackFn | Функция обратного вызова, которая вызывается при изменении FID. |
Возврат:
Функция, которую можно вызвать для отмены подписки.
IdChangeCallbackFn
Определенная пользователем функция обратного вызова, которая вызывается при изменении идентификатора установки.
Подпись:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeОтписатьсяFn
Отменить подписку на функцию обратного вызова, ранее добавленную через IdChangeCallbackFn . .
Подпись:
export declare type IdChangeUnsubscribeFn = () => void;