firebase-admin package

API пространства имен Firebase (устаревший).

Функции

Функция	Описание
приложение (имя)
appCheck(приложение)	Получает службу AppCheck для приложения по умолчанию или заданного приложения. admin.appCheck() можно вызвать без аргументов для доступа к службе AppCheck приложения по умолчанию или как admin.appCheck(app) для доступа к службе AppCheck , связанной с конкретным приложением.
авторизация (приложение)	Получает службу проверки подлинности для приложения по умолчанию или заданного приложения. admin.auth() можно вызвать без аргументов для доступа к службе аутентификации приложения по умолчанию или как admin.auth(app) для доступа к службе аутентификации, связанной с конкретным приложением.
база данных (приложение)	Получает службу базы данных для приложения по умолчанию или данного приложения. admin.database() можно вызвать без аргументов для доступа к службе Database приложения по умолчанию или как admin.database(app) для доступа к службе Database , связанной с конкретным приложением. admin.database — это также пространство имен, которое можно использовать для доступа к глобальным константам и методам, связанным со службой Database .
пожарный магазин (приложение)
инициализироватьПриложение (опции, имя)
установки (приложение)	Получает службу установки для приложения по умолчанию или заданного приложения. admin.installations() можно вызвать без аргументов для доступа к службе установки приложения по умолчанию или как admin.installations(app) для доступа к службе установки , связанной с конкретным приложением.
идентификатор экземпляра (приложение)	Получает службу InstanceId для приложения по умолчанию или заданного приложения. admin.instanceId() можно вызвать без аргументов для доступа к службе InstanceId приложения по умолчанию или как admin.instanceId(app) для доступа к службе InstanceId связанной с конкретным приложением.
машинное обучение (приложение)	Получает службу MachineLearning для приложения по умолчанию или заданного приложения. admin.machineLearning() можно вызвать без аргументов для доступа к службе MachineLearning приложения по умолчанию или как admin.machineLearning(app) для доступа к службе MachineLearning , связанной с конкретным приложением.
обмен сообщениями (приложение)	Получает службу обмена сообщениями для приложения по умолчанию или заданного приложения. admin.messaging() можно вызвать без аргументов для доступа к службе Messaging приложения по умолчанию или как admin.messaging(app) для доступа к службе Messaging связанной с конкретным приложением.
Управление проектом (приложение)	Получает службу ProjectManagement для приложения по умолчанию или заданного приложения. admin.projectManagement() можно вызвать без аргументов для доступа к службе ProjectManagement приложения по умолчанию или как admin.projectManagement(app) для доступа к службе ProjectManagement , связанной с конкретным приложением.
удаленная конфигурация (приложение)	Получает службу RemoteConfig для приложения по умолчанию или заданного приложения. admin.remoteConfig() можно вызвать без аргументов для доступа к службе RemoteConfig приложения по умолчанию или как admin.remoteConfig(app) для доступа к службе RemoteConfig , связанной с конкретным приложением.
SecurityRules (приложение)	Получает службу SecurityRules для приложения по умолчанию или заданного приложения. admin.securityRules() можно вызвать без аргументов для доступа к службе SecurityRules приложения по умолчанию или как admin.securityRules(app) для доступа к службе SecurityRules , связанной с конкретным приложением.
хранилище (приложение)	Получает службу хранилища для приложения по умолчанию или заданного приложения. admin.storage() можно вызвать без аргументов для доступа к службе Storage приложения по умолчанию или как admin.storage(app) для доступа к службе Storage , связанной с конкретным приложением.

Интерфейсы

Интерфейс	Описание
Параметры приложения	Доступные параметры для передачи в InitializeApp() .
FirebaseArrayIndexError	Составной тип, который включает в себя как объект FirebaseError , так и индекс, который можно использовать для получения элемента с ошибкой.
FirebaseError	FirebaseError — это подкласс стандартного объекта Error JavaScript. Помимо строки сообщения и трассировки стека, он содержит строковый код.
Токен GoogleOAuthAccess	Интерфейс для токенов доступа Google OAuth 2.0.
Сервисаккаунт

Пространства имен

Пространство имен	Описание
приложение
приложениеCheck
авторизация
полномочия
база данных
пожарная лавка
установки
идентификатор экземпляра
машинаОбучение
обмен сообщениями
управление проектом
удаленнаяконфигурация
Правила безопасности
хранилище

Переменные

Переменная	Описание
приложения
SDK_VERSION

приложение (имя)

Подпись:

export declare function app(name?: string): app.App;

Параметры

Параметр	Тип	Описание
имя	нить

Возврат:

приложение.Приложение

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

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

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

Подпись:

export declare function appCheck(app?: App): appCheck.AppCheck;

Параметры

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

Возврат:

appCheck.AppCheck

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

Пример 1

// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();

Пример 2

// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);

авторизация (приложение)

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

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

Подпись:

export declare function auth(app?: App): auth.Auth;

Параметры

Параметр	Тип	Описание
приложение	Приложение

Возврат:

авторизация.Auth

Пример 1

// Get the Auth service for the default app
var defaultAuth = admin.auth();

Пример 2

// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);

база данных (приложение)

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

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

admin.database — это также пространство имен, которое можно использовать для доступа к глобальным константам и методам, связанным со службой Database .

Подпись:

export declare function database(app?: App): database.Database;

Параметры

Параметр	Тип	Описание
приложение	Приложение

Возврат:

база данных.База данных

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

Пример 1

// Get the Database service for the default app
var defaultDatabase = admin.database();

Пример 2

// Get the Database service for a specific app
var otherDatabase = admin.database(app);

пожарный магазин (приложение)

Подпись:

export declare function firestore(app?: App): _firestore.Firestore;

Параметры

Параметр	Тип	Описание
приложение	Приложение

Возврат:

_firestore.Firestore

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

Подпись:

export declare function initializeApp(options?: AppOptions, name?: string): app.App;

Параметры

Параметр	Тип	Описание
параметры	Параметры приложения
имя	нить

Возврат:

приложение.Приложение

установки (приложение)

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

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

Подпись:

export declare function installations(app?: App): installations.Installations;

Параметры

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

Возврат:

инсталляции.Инсталляции

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

Пример 1

// Get the Installations service for the default app
var defaultInstallations = admin.installations();

Пример 2

// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);

идентификатор экземпляра (приложение)

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

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

Подпись:

export declare function instanceId(app?: App): instanceId.InstanceId;

Параметры

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

Возврат:

идентификатор экземпляра.Идентификатор экземпляра

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

Пример 1

// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();

Пример 2

// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);

машинное обучение (приложение)

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

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

Подпись:

export declare function machineLearning(app?: App): machineLearning.MachineLearning;

Параметры

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

Возврат:

MachineLearning.MachineLearning

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

Пример 1

// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();

Пример 2

// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);

обмен сообщениями (приложение)

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

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

Подпись:

export declare function messaging(app?: App): messaging.Messaging;

Параметры

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

Возврат:

обмен сообщениями.Сообщения

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

Пример 1

// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();

Пример 2

// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);

Управление проектом (приложение)

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

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

Подпись:

export declare function projectManagement(app?: App): projectManagement.ProjectManagement;

Параметры

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

Возврат:

ProjectManagement.ProjectManagement

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

Пример 1

// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();

Пример 2

// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);

удаленная конфигурация (приложение)

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

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

Подпись:

export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;

Параметры

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

Возврат:

RemoteConfig.RemoteConfig

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

Пример 1

// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();

Пример 2

// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);

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

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

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

Подпись:

export declare function securityRules(app?: App): securityRules.SecurityRules;

Параметры

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

Возврат:

SecurityRules.SecurityRules

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

Пример 1

// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();

Пример 2

// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);

хранилище (приложение)

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

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

Подпись:

export declare function storage(app?: App): storage.Storage;

Параметры

Параметр	Тип	Описание
приложение	Приложение

Возврат:

хранилище.Хранение

Пример 1

// Get the Storage service for the default app
var defaultStorage = admin.storage();

Пример 2

// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);

приложения

Подпись:

apps: (app.App | null)[]

SDK_VERSION

Подпись:

SDK_VERSION: string