firebase-admin package

Interfejs API przestrzeni nazw Firebase (starsza wersja).

Funkcje

Funkcja Opis
aplikacja(nazwa)
appCheck(aplikacja) Pobiera usługę AppCheck dla aplikacji domyślnej lub danej.Aplikacja admin.appCheck() może być wywoływana bez argumentów zapewniająca dostęp do usługi AppCheck domyślnej aplikacji lub jako admin.appCheck(app) w celu uzyskania dostępu do usługi AppCheck powiązanej z konkretną aplikacją.
auth(app) Pobiera usługę Auth dla aplikacji domyślnej lub danej.Aplikacja admin.auth() może być wywoływana bez argumentów umożliwiających dostęp do usługi Auth w domyślnej aplikacji lub jako admin.auth(app) w celu uzyskania dostępu do usługi Auth powiązanej z konkretną aplikacją.
baza_danych(aplikacja) Pobiera usługę bazy danych dla aplikacji domyślnej lub danej aplikacji.admin.database() może być wywoływany bez argumentów bez argumentów umożliwiających dostęp do usługi Database domyślnej aplikacji lub jako admin.database(app) w celu uzyskania dostępu do usługi Database powiązanej z konkretną aplikacją.admin.database jest także przestrzenią nazw, która umożliwia dostęp do stałych globalnych i metod powiązanych z usługą Database.
firestore(aplikacja)
initializeApp(opcje, nazwa)
instalacje(aplikacja) Pobiera usługę Instalacje dla aplikacji domyślnej lub danej aplikacji.admin.installations() można wywoływać bez argumentów umożliwiających 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ą.
instanceId(app), Pobiera usługę InstanceId dla aplikacji domyślnej lub danej aplikacji.admin.instanceId() może być wywoływany bez argumentów umożliwiający 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 lub konkretnej aplikacji.Metodę admin.machineLearning() można wywoływać bez argumentów umożliwiających dostęp do usługi MachineLearning domyślnej aplikacji lub jako admin.machineLearning(app) w celu uzyskania dostępu do usługi MachineLearning powiązanej z konkretną aplikacją.
wiadomości(aplikacja) Pobiera usługę Messaging dla aplikacji domyślnej lub danej aplikacji.Funkcja admin.messaging() może być wywoływana bez argumentów umożliwiających 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 aplikacji domyślnej lub danej.Aplikacja admin.projectManagement() może być wywoływana bez argumentów umożliwiających dostęp do usługi ProjectManagement domyślnej aplikacji lub jako admin.projectManagement(app) w celu uzyskania dostępu do usługi ProjectManagement powiązanej z konkretną aplikacją.
remoteConfig(aplikacja) Pobiera usługę RemoteConfig dla aplikacji domyślnej lub danej.admin.remoteConfig() może być wywoływany bez argumentów umożliwiający 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 aplikacji domyślnej lub danej aplikacji.admin.securityRules() może być wywoływany bez argumentów umożliwiających dostęp do usługi SecurityRules w domyślnej aplikacji lub jako admin.securityRules(app), aby uzyskać dostęp do usługi SecurityRules powiązanej z konkretną aplikacją.
storage(app) Pobiera usługę Pamięć dla aplikacji domyślnej lub danej.Aplikacja admin.storage() może być wywoływana bez argumentów zapewniająca 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 AppOptions Dostępne opcje przekazywania do initializeApp().
FirebaseTrackIndexError Typ złożony, który zawiera zarówno obiekt FirebaseError, jak i indeks, którego można użyć do pobrania elementu z błędem.
Błąd Firebase FirebaseError to podklasa standardowego obiektu JavaScript Error. Oprócz ciągu tekstowego komunikatu i zrzutu stosu zawiera on ciąg znaków.
GoogleOAuthAccessToken Interfejs tokenów dostępu Google OAuth 2.0.
Konto usługi

Przestrzenie nazw

Przestrzeń nazw Opis
aplikacja
Sprawdzanie aplikacji
auth
dane logowania
baza danych
firestore
instalacje
instanceId,
system uczący się
wiadomości
zarządzanie projektami
remoteConfig
securityRules (Reguły zabezpieczeń)
miejsce na dane

Zmienne

Zmienna Opis
aplikacje
SDK_VERSION

aplikacja(nazwa)

Podpis:

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

Parametry

Parametr Typ Opis
nazwa ciąg znaków

Zwroty:

app.App

appCheck(aplikacja)

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

Funkcja admin.appCheck() może być wywoływana bez argumentów umożliwiających dostęp do usługi AppCheck domyślnej aplikacji lub jako admin.appCheck(app) w celu uzyskania dostępu 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, w przypadku której ma zostać zwrócona usługa AppCheck. Jeśli nie zostanie podana, zwrócona zostanie domyślna usługa AppCheck.

Zwroty:

appCheck.AppCheck

Domyślna usługa AppCheck w przypadku braku 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 aplikacji domyślnej lub danej.

admin.auth() można wywołać bez argumentów umożliwiających dostęp do usługi Auth domyślnej aplikacji lub jako admin.auth(app) w celu uzyskania dostępu 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

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ę Baza danych dla aplikacji domyślnej lub danej.

Funkcja admin.database() może być wywoływana bez argumentów umożliwiających dostęp do usługi Database domyślnej aplikacji lub jako admin.database(app) w celu uzyskania dostępu do usługi Database powiązanej z konkretną aplikacją.

admin.database to również przestrzeń nazw, której można używać 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:

baza_danych.Baza danych

Domyślna usługa Database w przypadku braku aplikacji lub usługa Database powiązana z udostępnioną 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

inicjujApp(opcje, nazwa)

Podpis:

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

Parametry

Parametr Typ Opis
opcje Opcje AppOptions
nazwa ciąg znaków

Zwroty:

app.App

Instalacje(aplikacja)

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

admin.installations() można wywołać bez argumentów umożliwiających 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, dla której Installations ma zwrócić usługę. Jeśli nie zostanie podana, zwrócona zostanie domyślna usługa Installations.

Zwroty:

installations.Instalacje

Domyślna usługa Installations w przypadku braku aplikacji lub usługa Installations powiązana z udostępnioną 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 aplikacji domyślnej lub danej.

Funkcja admin.instanceId() może być wywoływana bez argumentów umożliwiających dostęp do usługi InstanceId domyślnej aplikacji lub jako admin.instanceId(app) w celu uzyskania dostępu 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, dla której InstanceId ma zwrócić usługę. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa InstanceId.

Zwroty:

Identyfikator instancji.Identyfikator instancji

Domyślna usługa InstanceId w przypadku braku aplikacji lub usługa InstanceId powiązana z udostępnioną 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 aplikacji domyślnej lub danej.

Funkcja admin.machineLearning() może być wywoływana bez argumentów umożliwiających dostęp do usługi MachineLearning domyślnej aplikacji lub jako admin.machineLearning(app) w celu uzyskania dostępu 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, dla której MachineLearning ma zwrócić usługę. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa MachineLearning.

Zwroty:

Uczenie maszynowe.Systemy uczące się

Domyślna usługa MachineLearning w przypadku braku aplikacji lub usługa MachineLearning powiązana z udostępnioną 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 z aplikacji domyślnej lub danej.

Funkcja admin.messaging() może być wywoływana bez argumentów umożliwiających dostęp do usługi Messaging domyślnej aplikacji lub jako admin.messaging(app) w celu uzyskania dostępu 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, dla której Messaging ma zwrócić usługę. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa Messaging.

Zwroty:

wiadomości.

Domyślna usługa Messaging w przypadku braku aplikacji lub usługa Messaging powiązana z udostępnioną 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);

projectManagement(aplikacja)

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

Funkcja admin.projectManagement() może być wywoływana bez argumentów umożliwiających dostęp do usługi ProjectManagement domyślnej aplikacji lub jako admin.projectManagement(app) w celu uzyskania dostępu 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, dla której ProjectManagement ma zwrócić usługę. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa ProjectManagement. *

Zwroty:

Zarządzanie projektami.Zarządzanie projektami

Domyślna usługa ProjectManagement w przypadku braku aplikacji lub usługa ProjectManagement powiązana z udostępnioną 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);

zdalna konfiguracja(aplikacja)

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

Funkcja admin.remoteConfig() może być wywoływana bez argumentów umożliwiających dostęp do usługi RemoteConfig domyślnej aplikacji lub jako admin.remoteConfig(app) w celu uzyskania dostępu 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, w przypadku której ma zostać zwrócona usługa RemoteConfig. Jeśli nie zostanie podana, zwrócona zostanie domyślna usługa RemoteConfig.

Zwroty:

remoteConfig.RemoteConfig

Domyślna usługa RemoteConfig w przypadku braku 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 aplikacji domyślnej lub danej.

admin.securityRules() można wywołać bez argumentów umożliwiających dostęp do usługi SecurityRules w 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, zwrócona zostanie domyślna usługa SecurityRules.

Zwroty:

securityRules.SecurityRules (w języku angielskim)

Domyślna usługa SecurityRules w przypadku braku 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);

pamięć(aplikacja)

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

Funkcja admin.storage() może być wywoływana bez argumentów umożliwiających dostęp do usługi Storage domyślnej aplikacji lub jako admin.storage(app) w celu uzyskania dostępu 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