firebase-admin.extensions package

Служба расширений Firebase.

Функции

Функция Описание
getExtensions (приложение) Получает службу расширений для приложения по умолчанию или заданного приложения. getExtensions() можно вызвать без аргументов для доступа к службе Extensions приложения по умолчанию или как getExtensions(app) для доступа к службе Extensions , связанной с конкретным приложением.

Классы

Сорт Описание
Расширения Интерфейс службы Extensions Firebase.
Время выполнения Среда выполнения предоставляет методы для изменения данных времени выполнения экземпляра расширения.

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

Введите псевдоним Описание
SettableProcessingState SettableProcessingState представляет все состояния обработки, которые могут быть установлены для данных времени выполнения экземпляра расширения.

getExtensions (приложение)

Получает службу расширений для приложения по умолчанию или заданного приложения.

getExtensions() можно вызвать без аргументов для доступа к службе Extensions приложения по умолчанию или как getExtensions(app) для доступа к службе Extensions , связанной с конкретным приложением.

Подпись:

export declare function getExtensions(app?: App): Extensions;

Параметры

Параметр Тип Описание
приложение Приложение Необязательное приложение, для которого нужно вернуть службу Extensions . Если он не указан, возвращается служба Extensions по умолчанию.

Возврат:

Расширения

Служба Extensions по умолчанию, если приложение не предоставлено, или служба Extensions , связанная с предоставленным приложением.

Пример 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Пример 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

SettableProcessingState

SettableProcessingState представляет все состояния обработки, которые могут быть установлены для данных времени выполнения экземпляра расширения.

Вы можете установить следующие состояния:

  • NONE : Никакой соответствующей работы по событиям жизненного цикла не проводилось. Установите это, чтобы очистить старые статусы.

  • PROCESSING_COMPLETE : Работа по событию жизненного цикла завершена без ошибок.

  • PROCESSING_WARNING : обработка событий жизненного цикла выполнена частично, или произошло что-то, о чем следует предупредить пользователя.

  • PROCESSING_FAILED : обработка событий жизненного цикла полностью завершилась неудачей, но экземпляр по-прежнему будет работать корректно.

Если экземпляр расширения находится в неисправном состоянии из-за ошибок, вместо этого вызовите Runtime.setFatalError(). .

Состояние «обработка» устанавливается автоматически при запуске обработчика событий жизненного цикла; вы не можете установить это явно. Чтобы сообщить о текущем состоянии функции расширения, используйте console.log или SDK средства ведения журнала Cloud Functions.

Подпись:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';