firebase-admin package

Interfejs API Firebase z przestrzeni nazw (starsza wersja).

Funkcje

Funkcja	Opis
nazwa aplikacji
appCheck(aplikacja)	Pobiera usługę AppCheck dla domyślnej aplikacji lub aplikacji.admin.appCheck() można wywołać bez argumentów, aby uzyskać dostęp do usługi AppCheck domyślnej aplikacji, lub jako admin.appCheck(app), aby uzyskać dostęp do usługi AppCheck powiązanej z konkretną aplikacją.
auth(aplikacja)	Pobiera usługę Auth dla domyślnej aplikacji lub danej aplikacji.admin.auth() można wywołać bez argumentów, aby uzyskać dostęp do usługi Auth w domyślnej aplikacji, lub jako admin.auth(app), aby uzyskać dostęp do usługi Auth powiązanej z konkretną aplikacją.
baza_danych(aplikacja)	Pobiera usługę bazy danych dla domyślnej aplikacji lub aplikacji.admin.database() można wywołać bez argumentów, aby uzyskać dostęp do usługi Database domyślnej aplikacji, lub jako admin.database(app), aby uzyskać dostęp do usługi Database powiązanej z konkretną aplikacją.admin.database to także przestrzeń nazw, która może służyć do uzyskiwania dostępu do globalnych stałych i metod powiązanych z usługą Database.
firestore(aplikacja)
initializeApp(opcje; nazwa)
instalacje(aplikacja)	Pobiera usługę Instalacje dla domyślnej aplikacji lub aplikacji.admin.installations() można wywołać bez argumentów, aby uzyskać dostęp do usługi Instalacje aplikacji domyślnej lub jako admin.installations(app), aby uzyskać dostęp do usługi Instalacje powiązanej z konkretną aplikacją.
instanceId(aplikacja)	Pobiera usługę InstanceId dla domyślnej aplikacji lub aplikacji.admin.instanceId() można wywołać bez argumentów, aby uzyskać dostęp do usługi InstanceId domyślnej aplikacji, lub jako admin.instanceId(app), aby uzyskać dostęp do usługi InstanceId powiązanej z konkretną aplikacją.
machineLearning(aplikacja)	Pobiera usługę MachineLearning dla domyślnej aplikacji lub aplikacji.admin.machineLearning() można wywołać bez argumentów, aby uzyskać dostęp do usługi MachineLearning domyślnej aplikacji, lub jako admin.machineLearning(app), aby uzyskać dostęp do usługi MachineLearning powiązanej z konkretną aplikacją.
wiadomości(aplikacja)	Pobiera usługę Messaging (wiadomości) dla domyślnej aplikacji lub aplikacji.admin.messaging() można wywołać bez argumentów, by uzyskać dostęp do usługi Messaging domyślnej aplikacji, lub jako admin.messaging(app), aby uzyskać dostęp do usługi Messaging powiązanej z konkretną aplikacją.
projectManagement(aplikacja)	Pobiera usługę ProjectManagement dla domyślnej aplikacji lub danej aplikacji.admin.projectManagement() można wywołać bez argumentów, aby uzyskać dostęp do usługi ProjectManagement domyślnej aplikacji, lub jako admin.projectManagement(app), aby uzyskać dostęp do usługi ProjectManagement powiązanej z konkretną aplikacją.
remoteConfig(aplikacja)	Pobiera usługę RemoteConfig dla domyślnej aplikacji lub aplikacji.admin.remoteConfig() można wywołać bez argumentów, aby uzyskać dostęp do usługi RemoteConfig domyślnej aplikacji, lub jako admin.remoteConfig(app), aby uzyskać dostęp do usługi RemoteConfig powiązanej z konkretną aplikacją.
securityRules(aplikacja)	Pobiera usługę SecurityRules dla domyślnej aplikacji lub aplikacji.admin.securityRules() można wywołać bez argumentów, aby uzyskać dostęp do usługi SecurityRules w domyślnej aplikacji, lub jako admin.securityRules(app), by uzyskać dostęp do usługi SecurityRules powiązanej z konkretną aplikacją.
miejsce(aplikacja)	Pobiera usługę Pamięć dla domyślnej aplikacji lub aplikacji.admin.storage() można wywołać bez argumentów, aby uzyskać dostęp do usługi Storage domyślnej aplikacji, lub jako admin.storage(app), aby uzyskać dostęp do usługi Storage powiązanej z konkretną aplikacją.

Interfejsy

Interfejs	Opis
Opcje aplikacji	Dostępne opcje przekazywania do metody initializeApp().
FirebasetablicaIndexError	Typ złożony: zawiera zarówno obiekt FirebaseError, jak i indeks, za pomocą których można uzyskać nieprawidłowy element.
Błąd Firebase	FirebaseError to podklasa standardowego obiektu JavaScript Error. Oprócz ciągu znaków wiadomości i zrzutu stosu zawiera on kod ciągu znaków.
GoogleOAuthAccessToken	Interfejs tokenów dostępu Google OAuth 2.0.
Konto usługi

Przestrzenie nazw

Przestrzeń nazw	Opis
aplikacja
appCheck
auth
dane logowania
baza_danych
firestore,
instalacje
instanceId;
systemy uczące się
wiadomości
Zarządzanie projektami
remoteConfig
securityRules (Reguły zabezpieczeń)
miejsce na dane

Zmienne

Zmienna	Opis
aplikacje
SDK_VERSION

app(nazwa)

Podpis:

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

Parametry

Parametr	Typ	Opis
name	string,

Zwroty:

aplikacja.Aplikacja

appCheck(aplikacja)

Pobiera usługę AppCheck dla domyślnej lub konkretnej aplikacji.

Funkcję admin.appCheck() można wywołać bez argumentów, aby uzyskać dostęp do usługi AppCheck domyślnej aplikacji, lub jako admin.appCheck(app), aby uzyskać dostęp do usługi AppCheck powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, dla której ma zostać zwrócona usługa AppCheck. Jeśli nie zostanie podana, zwracana jest domyślna usługa AppCheck.

Zwroty:

appCheck.AppCheck

Domyślna usługa AppCheck, jeśli nie podano żadnej aplikacji, lub usługa AppCheck powiązana z udostępnioną aplikacją.

Przykład 1

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

Przykład 2

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

auth(aplikacja)

Pobiera usługę Auth dla domyślnej lub danej aplikacji.

admin.auth() można wywołać bez argumentów, aby uzyskać dostęp do usługi Auth w domyślnej aplikacji, lub jako admin.auth(app), aby uzyskać dostęp do usługi Auth powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja

Zwroty:

auth.Auth (Uwierzytelnianie.Auth).

Przykład 1

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

Przykład 2

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

baza danych(aplikacja)

Pobiera usługę bazy danych dla domyślnej aplikacji lub danej aplikacji.

Funkcję admin.database() można wywołać bez argumentów, aby uzyskać dostęp do usługi Database domyślnej aplikacji, lub jako admin.database(app), aby uzyskać dostęp do usługi Database powiązanej z konkretną aplikacją.

admin.database to także przestrzeń nazw, która może służyć do uzyskiwania dostępu do stałych globalnych i metod powiązanych z usługą Database.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja

Zwroty:

database.Baza danych

Domyślna usługa Database, jeśli nie podano żadnej aplikacji lub usługa Database powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

Firestore(aplikacja)

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja

Zwroty:

_firestore.Firestore

zainicjujApp(opcje; nazwa)

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	Opcje aplikacji
name	string,

Zwroty:

aplikacja.Aplikacja

instalacje(aplikacja)

Pobiera usługę Instalacje dla domyślnej aplikacji lub danej aplikacji.

admin.installations() można wywołać bez argumentów, aby uzyskać dostęp do usługi Instalacje domyślnej aplikacji, lub jako admin.installations(app), aby uzyskać dostęp do usługi Instalacje powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa Installations ma zostać zwrócona. Jeśli nie zostanie podana, zwracana jest domyślna usługa Installations.

Zwroty:

installations.Instalacje

Domyślna usługa Installations, jeśli nie podano żadnej aplikacji lub usługa Installations powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

Identyfikator instancji(aplikacja)

Pobiera usługę InstanceId dla domyślnej aplikacji lub danej aplikacji.

Funkcję admin.instanceId() można wywołać bez argumentów, aby uzyskać dostęp do usługi InstanceId domyślnej aplikacji, lub jako admin.instanceId(app), aby uzyskać dostęp do usługi InstanceId powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa InstanceId ma zostać zwrócona. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa InstanceId.

Zwroty:

instanceId.InstanceId

Domyślna usługa InstanceId, jeśli nie podano żadnej aplikacji lub usługa InstanceId powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

MachineLearning(aplikacja)

Pobiera usługę MachineLearning dla domyślnej aplikacji lub danej aplikacji.

Funkcję admin.machineLearning() można wywołać bez argumentów, aby uzyskać dostęp do usługi MachineLearning domyślnej aplikacji, lub jako admin.machineLearning(app), aby uzyskać dostęp do usługi MachineLearning powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa MachineLearning ma zostać zwrócona. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa MachineLearning.

Zwroty:

machineLearning.MachineLearning

Domyślna usługa MachineLearning, jeśli nie podano żadnej aplikacji lub usługa MachineLearning powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

wiadomości(aplikacja)

Pobiera usługę Messaging (wiadomości) z domyślnej lub konkretnej aplikacji.

Funkcję admin.messaging() można wywołać bez argumentów, aby uzyskać dostęp do usługi Messaging domyślnej aplikacji, lub jako admin.messaging(app), aby uzyskać dostęp do usługi Messaging powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa Messaging ma zostać zwrócona. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa Messaging.

Zwroty:

messaging.Messaging,

Domyślna usługa Messaging, jeśli nie podano żadnej aplikacji lub usługa Messaging powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

zarządzanie projektami(aplikacja)

Pobiera usługę ProjectManagement dla domyślnej aplikacji lub danej aplikacji.

Funkcję admin.projectManagement() można wywołać bez argumentów, aby uzyskać dostęp do usługi ProjectManagement domyślnej aplikacji, lub jako admin.projectManagement(app), aby uzyskać dostęp do usługi ProjectManagement powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa ProjectManagement ma zostać zwrócona. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa ProjectManagement. *

Zwroty:

projectManagement.ProjectManagement

Domyślna usługa ProjectManagement, jeśli nie podano żadnej aplikacji lub usługa ProjectManagement powiązana z daną aplikacją.

Przykład 1

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

Przykład 2

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

zdalnej konfiguracji(aplikacja)

Pobiera usługę RemoteConfig dla domyślnej aplikacji lub danej aplikacji.

Funkcję admin.remoteConfig() można wywołać bez argumentów, aby uzyskać dostęp do usługi RemoteConfig domyślnej aplikacji, lub jako admin.remoteConfig(app), aby uzyskać dostęp do usługi RemoteConfig powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, dla której ma zostać zwrócona usługa RemoteConfig. Jeśli nie zostanie podana, zwracana jest domyślna usługa RemoteConfig.

Zwroty:

remoteConfig.RemoteConfig

Domyślna usługa RemoteConfig, jeśli nie podano żadnej aplikacji, lub usługa RemoteConfig powiązana z udostępnioną aplikacją.

Przykład 1

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

Przykład 2

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

SecurityRules(aplikacja)

Pobiera usługę SecurityRules dla domyślnej aplikacji lub aplikacji.

admin.securityRules() można wywołać bez użycia argumentów, aby uzyskać dostęp do usługi SecurityRules dla domyślnej aplikacji, lub jako admin.securityRules(app), aby uzyskać dostęp do usługi SecurityRules powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, dla której ma zostać zwrócona usługa SecurityRules. Jeśli nie zostanie podana, zwracana jest domyślna usługa SecurityRules.

Zwroty:

securityRules.SecurityRules (Reguły zabezpieczeń).

Domyślna usługa SecurityRules, jeśli nie podano żadnej aplikacji, lub usługa SecurityRules powiązana z udostępnioną aplikacją.

Przykład 1

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

Przykład 2

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

miejsce na dane(aplikacja)

Pobiera usługę Pamięć dla domyślnej lub określonej aplikacji.

Funkcję admin.storage() można wywołać bez argumentów, aby uzyskać dostęp do usługi Storage domyślnej aplikacji, lub jako admin.storage(app), aby uzyskać dostęp do usługi Storage powiązanej z konkretną aplikacją.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja

Zwroty:

storage.Storage

Przykład 1

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

Przykład 2

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

aplikacje

Podpis:

apps: (app.App | null)[]

SDK_VERSION

Podpis:

SDK_VERSION: string