app-check package

Веб-SDK проверки приложений Firebase.

Проверка приложений Firebase не работает в среде Node.js с использованием ReCaptchaV3Provider или ReCaptchaEnterpriseProvider , но его можно использовать в Node.js, если вы используете CustomProvider и пишете собственный метод аттестации.

Функции

Классы

Интерфейсы

Введите псевдонимы

функция (приложение, ...)

инициализироватьAppCheck(приложение, параметры)

Активируйте проверку приложений для данного приложения. Можно вызвать только один раз для каждого приложения.

Подпись:

export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;

Параметры

Возврат:

AppCheck

функция (appCheckInstance, ...)

getLimitedUseToken (appCheckInstance)

Запрашивает токен проверки приложений Firebase. Этот метод следует использовать только в том случае, если вам необходимо авторизовать запросы к серверу, отличному от Firebase.

Возвращает токены ограниченного использования, предназначенные для использования с вашими серверными конечными точками, не относящимися к Firebase, которые защищены защитой от воспроизведения . Этот метод не влияет на поведение генерации токенов метода #getAppCheckToken().

Подпись:

export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;

Параметры

Возврат:

Обещание < AppCheckTokenResult >

Токен ограниченного использования.

getToken (appCheckInstance, ForceRefresh)

Получите текущий токен проверки приложений. Если forceRefresh имеет значение false, эта функция сначала проверяет наличие допустимого токена в памяти, а затем локальное постоянство (IndexedDB). Если он не найден или если forceRefresh имеет значение true, он отправляет запрос к конечной точке проверки приложений для получения нового токена. Этот запрос присоединяется к самому последнему текущему запросу, если таковой имеется.

Подпись:

export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;

Параметры

Возврат:

Обещание < AppCheckTokenResult >

onTokenChanged (appCheckInstance, наблюдатель)

Регистрирует прослушиватель изменений состояния токена. Одновременно может быть зарегистрировано несколько прослушивателей для одного или нескольких экземпляров проверки приложений. Прослушиватели выполняют обратный вызов в потоке пользовательского интерфейса всякий раз, когда изменяется текущий токен, связанный с этим экземпляром проверки приложения.

Подпись:

export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;

Параметры

Возврат:

Отписаться

Функция, которая отписывает этого слушателя.

onTokenChanged (appCheckInstance, onNext, onError, onCompletion)

Регистрирует прослушиватель изменений состояния токена. Одновременно может быть зарегистрировано несколько прослушивателей для одного или нескольких экземпляров проверки приложений. Прослушиватели выполняют обратный вызов в потоке пользовательского интерфейса всякий раз, когда изменяется текущий токен, связанный с этим экземпляром проверки приложения.

Подпись:

export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;

Параметры

Возврат:

Отписаться

Функция, которая отписывает этого слушателя.

setTokenAutoRefreshEnabled (appCheckInstance, isTokenAutoRefreshEnabled)

Укажите, будет ли проверка приложений автоматически обновлять токены по мере необходимости.

Подпись:

export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;

Параметры

Возврат:

пустота

AppCheckTokenListener

Прослушиватель, который вызывается всякий раз, когда изменяется токен проверки приложения.

Подпись:

export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;