Interfejs API z przestrzenią nazw Firebase (starsza wersja).
Funkcje
Funkcjonować | Opis |
---|---|
Nazwa aplikacji) | |
sprawdzenie aplikacji (aplikacja) | Pobiera usługę AppCheck dla aplikacji domyślnej lub danej aplikacji. admin.appCheck() może zostać wywołana bez argumentów, aby uzyskać 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ą. |
autoryzacja (aplikacja) | Pobiera usługę uwierzytelniania dla aplikacji domyślnej lub danej aplikacji. admin.auth() może zostać wywołana bez argumentów, aby uzyskać 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ą. |
baza danych (aplikacja) | Pobiera usługę bazy danych dla aplikacji domyślnej lub danej aplikacji. admin.database() może zostać wywołana bez argumentów, aby uzyskać 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 także przestrzeń nazw, za pomocą której można uzyskać dostęp do stałych globalnych i metod powiązanych z usługą Database . |
Firestore (aplikacja) | |
zainicjujAplikację(opcje, nazwa) | |
instalacje (aplikacja) | Pobiera usługę instalacji dla aplikacji domyślnej lub danej aplikacji. admin.installations() może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi instalacji domyślnej aplikacji, lub jako admin.installations(app) w celu uzyskania dostępu do usługi instalacji powiązanej z konkretną aplikacją. |
identyfikator instancji (aplikacja) | Pobiera usługę InstanceId dla aplikacji domyślnej lub danej 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) w celu uzyskania dostępu do usługi InstanceId powiązanej z konkretną aplikacją. |
Uczenie maszynowe (aplikacja) | Pobiera usługę MachineLearning dla aplikacji domyślnej lub danej aplikacji. admin.machineLearning() może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi MachineLearning aplikacji domyślnej, lub jako admin.machineLearning(app) w celu uzyskania dostępu do usługi MachineLearning powiązanej z określoną aplikacją. |
wiadomości (aplikacja) | Pobiera usługę Messaging dla aplikacji domyślnej lub danej aplikacji. admin.messaging() może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi Messaging w domyślnej aplikacji, lub jako admin.messaging(app) w celu uzyskania dostępu do usługi Messaging powiązanej z konkretną aplikacją. |
Zarządzanie projektami (aplikacja) | Pobiera usługę ProjectManagement dla aplikacji domyślnej lub danej aplikacji. admin.projectManagement() może zostać wywołana bez argumentów, aby uzyskać 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ą. |
zdalna konfiguracja (aplikacja) | Pobiera usługę RemoteConfig dla aplikacji domyślnej lub danej aplikacji. admin.remoteConfig() może zostać wywołana bez argumentów, aby uzyskać 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 określoną aplikacją. |
zasady bezpieczeństwa (aplikacja) | Pobiera usługę SecurityRules dla aplikacji domyślnej lub danej aplikacji. admin.securityRules() może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi SecurityRules domyślnej aplikacji, lub jako admin.securityRules(app) w celu uzyskania dostępu do usługi SecurityRules powiązanej z konkretną aplikacją. |
pamięć (aplikacja) | Pobiera usługę Storage dla aplikacji domyślnej lub danej aplikacji. admin.storage() może zostać wywołana bez argumentów, aby uzyskać 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ą. |
Interfejsy
Interfejs | Opis |
---|---|
Opcje aplikacji | Dostępne opcje do przekazania do zainicjowaniaApp() . |
Błąd FirebaseArrayIndex | Typ złożony, który zawiera zarówno obiekt FirebaseError , jak i indeks, którego można użyć do uzyskania elementu zawierającego błąd. |
Błąd Firebase | FirebaseError jest podklasą standardowego obiektu JavaScript Error . Oprócz ciągu komunikatu i śledzenia stosu zawiera kod ciągu. |
Token GoogleOAuthAccess | Interfejs dla tokenów dostępu Google OAuth 2.0. |
Konto serwisowe |
Przestrzenie nazw
Zmienne
Zmienny | Opis |
---|---|
aplikacje | |
SDK_WERSJA |
aplikacja()
Podpis:
export declare function app(name?: string): app.App;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy |
Zwroty:
kontrola aplikacji()
Pobiera usługę AppCheck dla aplikacji domyślnej lub danej aplikacji.
admin.appCheck()
może zostać wywołana bez argumentów, aby uzyskać 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, dla której można zwrócić usługę AppCheck . Jeśli nie zostanie podany, zwracana jest domyślna usługa AppCheck . |
Zwroty:
Domyślna usługa AppCheck
, jeśli nie jest dostępna żadna aplikacja, lub usługa AppCheck
powiązana z dostarczoną 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);
autoryzacja()
Pobiera usługę uwierzytelniania dla aplikacji domyślnej lub danej aplikacji.
admin.auth()
może zostać wywołana bez argumentów, aby uzyskać 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:
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()
Pobiera usługę bazy danych dla aplikacji domyślnej lub danej aplikacji.
admin.database()
może zostać wywołana bez argumentów, aby uzyskać 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 także przestrzeń nazw, za pomocą której można uzyskać dostęp 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:
Domyślna usługa Database
, jeśli nie dostarczono żadnej aplikacji, lub usługa Database
powiązana z dostarczoną 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);
sklep z ogniem()
Podpis:
export declare function firestore(app?: App): _firestore.Firestore;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja |
Zwroty:
_firestore.Firestore
zainicjuj aplikację()
Podpis:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje aplikacji | |
nazwa | strunowy |
Zwroty:
instalacje()
Pobiera usługę instalacji dla aplikacji domyślnej lub danej aplikacji.
admin.installations()
może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi instalacji domyślnej aplikacji, lub jako admin.installations(app)
w celu uzyskania dostępu do usługi instalacji 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 podany, zwracana jest domyślna usługa Installations . |
Zwroty:
Domyślna usługa Installations
, jeśli nie jest dostępna żadna aplikacja, lub usługa Installations
powiązana z dostarczoną 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()
Pobiera usługę InstanceId dla aplikacji domyślnej lub danej 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)
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, której usługa InstanceId ma zostać zwrócona. Jeśli nie zostanie podany, zwrócona zostanie domyślna usługa InstanceId . |
Zwroty:
identyfikator instancji.Identyfikator instancji
Domyślna usługa InstanceId
, jeśli nie dostarczono żadnej aplikacji lub usługa InstanceId
skojarzona z dostarczoną 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);
nauczanie maszynowe()
Pobiera usługę MachineLearning dla aplikacji domyślnej lub danej aplikacji.
admin.machineLearning()
może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi MachineLearning
aplikacji domyślnej, lub jako admin.machineLearning(app)
w celu uzyskania dostępu do usługi MachineLearning
powiązanej z określoną 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 podany, zostanie zwrócona domyślna usługa MachineLearning . |
Zwroty:
Uczenie maszynowe. Uczenie maszynowe
Domyślna usługa MachineLearning
, jeśli nie jest dostępna żadna aplikacja, lub usługa MachineLearning
powiązana z dostarczoną 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);
przesyłanie wiadomości()
Pobiera usługę Messaging dla aplikacji domyślnej lub danej aplikacji.
admin.messaging()
może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi Messaging
w 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, której usługa Messaging ma zostać zwrócona. Jeśli nie zostanie podany, zwrócona zostanie domyślna usługa Messaging . |
Zwroty:
Domyślna usługa Messaging
, jeśli nie jest dostępna żadna aplikacja, lub usługa Messaging
powiązana z dostarczoną 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 projektem()
Pobiera usługę ProjectManagement dla aplikacji domyślnej lub danej aplikacji.
admin.projectManagement()
może zostać wywołana bez argumentów, aby uzyskać 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, której usługa ProjectManagement ma zostać zwrócona. Jeśli nie zostanie podany, zwrócona zostanie domyślna usługa ProjectManagement . * |
Zwroty:
zarządzanie projektami.Zarządzanie projektami
Domyślna usługa ProjectManagement
jeśli nie dostarczono żadnej aplikacji, lub usługa ProjectManagement
powiązana z dostarczoną 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()
Pobiera usługę RemoteConfig dla aplikacji domyślnej lub danej aplikacji.
admin.remoteConfig()
może zostać wywołana bez argumentów, aby uzyskać 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 określoną 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 podany, zwracana jest domyślna usługa RemoteConfig . |
Zwroty:
Domyślna usługa RemoteConfig
jeśli nie jest dostępna żadna aplikacja, lub usługa RemoteConfig
powiązana z dostarczoną 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);
reguły bezpieczeństwa()
Pobiera usługę SecurityRules dla aplikacji domyślnej lub danej aplikacji.
admin.securityRules()
może zostać wywołana bez argumentów, aby uzyskać dostęp do usługi SecurityRules domyślnej aplikacji, lub jako admin.securityRules(app)
w celu uzyskania dostępu 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 można zwrócić usługę SecurityRules . Jeśli nie zostanie podany, zwracana jest domyślna usługa SecurityRules . |
Zwroty:
Domyślna usługa SecurityRules
jeśli nie dostarczono żadnej aplikacji, lub usługa SecurityRules
skojarzona z dostarczoną 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);
składowanie()
Pobiera usługę Storage dla aplikacji domyślnej lub danej aplikacji.
admin.storage()
może zostać wywołana bez argumentów, aby uzyskać 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:
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_WERSJA
Podpis:
SDK_VERSION: string