firebase-admin package

Firebase ad alanı API'si (eski).

İşlevler

İşlev	Açıklama
uygulama(ad)
appCheck(uygulama)	Varsayılan uygulama veya belirli bir uygulama için AppCheck hizmetini alır.admin.appCheck(), varsayılan uygulamanın AppCheck hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş AppCheck hizmetine erişmek için admin.appCheck(app) olarak çağrılabilir.
auth(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Auth hizmetini alır.admin.auth(), varsayılan uygulamanın Auth hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Auth hizmetine erişmek için admin.auth(app) olarak çağrılabilir.
database(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Database hizmetini alır.admin.database(), varsayılan uygulamanın Database hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkili Database hizmetine erişmek için admin.database(app) olarak çağrılabilir.admin.database, ayrıca Database hizmetiyle ilişkili genel sabit değerlere ve yöntemlere erişmek için kullanılabilen bir ad alanıdır.
firestore(uygulama)
initializeApp(options, ad)
yüklemeler(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Yüklemeler hizmetini alır.admin.installations(), varsayılan uygulamanın Yüklemeler hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Yüklemeler hizmetine erişmek için admin.installations(app) olarak çağrılabilir.
instanceId(uygulama)	Varsayılan uygulama veya belirli bir uygulama için InstanceId hizmetini alır.admin.instanceId(), varsayılan uygulamanın InstanceId hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş InstanceId hizmetine erişmek için admin.instanceId(app) olarak çağrılabilir.
machineLearning(uygulama)	Varsayılan uygulama veya belirli bir uygulama için MachineLearning hizmetini alır.admin.machineLearning(), varsayılan uygulamanın MachineLearning hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş MachineLearning hizmetine erişmek için admin.machineLearning(app) olarak çağrılabilir.
mesajlaşma(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Mesajlaşma hizmetini alır.admin.messaging(), varsayılan uygulamanın Messaging hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Messaging hizmetine erişmek için admin.messaging(app) olarak çağrılabilir.
projectManagement(uygulama)	Varsayılan uygulama veya belirli bir uygulama için ProjectManagement hizmetini alır.admin.projectManagement(), varsayılan uygulamanın ProjectManagement hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş ProjectManagement hizmetine erişmek için admin.projectManagement(app) olarak çağrılabilir.
remoteConfig(uygulama)	Varsayılan uygulama veya belirli bir uygulama için RemoteConfig hizmetini alır.admin.remoteConfig(), varsayılan uygulamanın RemoteConfig hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş RemoteConfig hizmetine erişmek için admin.remoteConfig(app) olarak çağrılabilir.
securityRules(uygulama)	Varsayılan uygulama veya belirli bir uygulama için SecurityRules hizmetini alır.admin.securityRules(), varsayılan uygulamanın SecurityRules hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş SecurityRules hizmetine erişmek için admin.securityRules(app) olarak çağrılabilir.
storage(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Depolama hizmetini alır.admin.storage(), varsayılan uygulamanın Storage hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Storage hizmetine erişmek için admin.storage(app) olarak çağrılabilir.

Arayüzler

Arayüz	Açıklama
Uygulama Seçenekleri	initializeApp() işlevine iletmek için kullanılabilecek seçenekler.
FirebaseArrayIndexError	Hatalı öğeyi almak için kullanılabilecek bir FirebaseError nesnesi ve bir dizin içeren birleşik tür.
Firebase Hatası	FirebaseError, standart JavaScript Error nesnesinin alt sınıfıdır. Mesaj dizesi ve yığın izlemeye ek olarak, dize kodu da içerir.
GoogleOAuthAccessToken	Google OAuth 2.0 erişim jetonları arayüzü.
HizmetHesabı

Ad alanları

Ad alanı	Açıklama
uygulama
uygulama Kontrolü
kimlik doğrulama
kimlik bilgisi
veritabanı
firestore
kurulumlar
instanceId
machineLearning
mesajlaşma
proje Yönetimi
remoteConfig
securityRules
depolama alanı

Değişkenler

Değişken	Açıklama
uygulamalar
SDK_VERSION

uygulama(ad)

İmza:

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

Parametreler

Parametre	Tür	Açıklama
ad	dize

Şunu döndürür:

uygulama.Uygulama

appCheck(uygulama)

Varsayılan uygulama veya belirli bir uygulama için AppCheck hizmetini alır.

admin.appCheck(), varsayılan uygulamanın AppCheck hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş AppCheck hizmetine erişmek için admin.appCheck(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	AppCheck hizmetinin iade edileceği isteğe bağlı uygulama. Sağlanmazsa varsayılan AppCheck hizmeti döndürülür.

Şunu döndürür:

appCheck.AppCheck

Uygulama sağlanmamışsa varsayılan AppCheck hizmeti veya sağlanan uygulamayla ilişkilendirilmiş AppCheck hizmeti.

1. örnek

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

2. örnek

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

auth(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Auth hizmetini alır.

admin.auth(), varsayılan uygulamanın Auth hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Auth hizmetine erişmek için admin.auth(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama

Şunu döndürür:

auth.Auth

1. örnek

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

2. örnek

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

veritabanı(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Veritabanı hizmetini alır.

admin.database(), varsayılan uygulamanın Database hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Database hizmetine erişmek için admin.database(app) olarak çağrılabilir.

admin.database aynı zamanda Database hizmetiyle ilişkili küresel sabit değerlere ve yöntemlere erişmek için kullanılabilecek bir ad alanıdır.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama

Şunu döndürür:

veritabanı.Veritabanı

Uygulama sağlanmamışsa varsayılan Database hizmeti veya sağlanan uygulamayla ilişkili Database hizmeti.

1. örnek

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

2. örnek

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

firestore(uygulama)

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama

Şunu döndürür:

_firestore.Firestore

startizeApp(seçenekler; ad)

İmza:

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

Parametreler

Parametre	Tür	Açıklama
seçenekler	Uygulama Seçenekleri
ad	dize

Şunu döndürür:

uygulama.Uygulama

yükleme(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Yüklemeler hizmetini alır.

admin.installations(), varsayılan uygulamanın Yüklemeler hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Yüklemeler hizmetine erişmek için admin.installations(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	Installations hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan Installations hizmeti döndürülür.

Şunu döndürür:

installations.Yüklemeler

Uygulama sağlanmamışsa varsayılan Installations hizmeti veya sağlanan uygulamayla ilişkili Installations hizmeti.

1. örnek

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

2. örnek

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

ornekKimliği(uygulama)

Varsayılan uygulama veya belirli bir uygulama için InstanceId hizmetini alır.

admin.instanceId(), varsayılan uygulamanın InstanceId hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş InstanceId hizmetine erişmek için admin.instanceId(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	InstanceId hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan InstanceId hizmeti döndürülür.

Şunu döndürür:

ornekKimliği.ÖrnekKimliği

Uygulama sağlanmamışsa varsayılan InstanceId hizmeti veya sağlanan uygulamayla ilişkili InstanceId hizmeti.

1. örnek

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

2. örnek

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

MachineLearning(uygulama)

Varsayılan uygulama veya belirli bir uygulama için MachineLearning hizmetini alır.

admin.machineLearning(), varsayılan uygulamanın MachineLearning hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş MachineLearning hizmetine erişmek için admin.machineLearning(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	MachineLearning hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan MachineLearning hizmeti döndürülür.

Şunu döndürür:

machineLearning.MachineLearning

Uygulama sağlanmamışsa varsayılan MachineLearning hizmeti veya sağlanan uygulamayla ilişkili MachineLearning hizmeti.

1. örnek

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

2. örnek

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

mesajlaşma(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Mesajlaşma hizmetini alır.

admin.messaging(), varsayılan uygulamanın Messaging hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Messaging hizmetine erişmek için admin.messaging(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	Messaging hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan Messaging hizmeti döndürülür.

Şunu döndürür:

messaging.Mesajlaşma

Uygulama sağlanmamışsa varsayılan Messaging hizmeti veya sağlanan uygulamayla ilişkili Messaging hizmeti.

1. örnek

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

2. örnek

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

proje Yönetimi(uygulama)

Varsayılan uygulama veya belirli bir uygulama için ProjectManagement hizmetini alır.

admin.projectManagement(), varsayılan uygulamanın ProjectManagement hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş ProjectManagement hizmetine erişmek için admin.projectManagement(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	ProjectManagement hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan ProjectManagement hizmeti döndürülür. *

Şunu döndürür:

projeYönetimi.ProjeYönetimi

Uygulama sağlanmamışsa varsayılan ProjectManagement hizmeti veya sağlanan uygulamayla ilişkili ProjectManagement hizmeti.

1. örnek

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

2. örnek

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

RemoteConfig(uygulama)

Varsayılan uygulama veya belirli bir uygulama için RemoteConfig hizmetini alır.

admin.remoteConfig(), varsayılan uygulamanın RemoteConfig hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş RemoteConfig hizmetine erişmek için admin.remoteConfig(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	RemoteConfig hizmetinin iade edileceği isteğe bağlı uygulama. Sağlanmazsa varsayılan RemoteConfig hizmeti döndürülür.

Şunu döndürür:

remoteConfig.RemoteConfig

Uygulama sağlanmamışsa varsayılan RemoteConfig hizmeti veya sağlanan uygulamayla ilişkilendirilmiş RemoteConfig hizmeti.

1. örnek

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

2. örnek

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

güvenlikKuralları(uygulama)

Varsayılan uygulama veya belirli bir uygulama için SecurityRules hizmetini alır.

admin.securityRules(), varsayılan uygulamanın SecurityRules hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş SecurityRules hizmetine erişmek için admin.securityRules(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama	SecurityRules hizmetinin iade edilmesi için isteğe bağlı uygulama. Sağlanmazsa varsayılan SecurityRules hizmeti döndürülür.

Şunu döndürür:

securityRules.SecurityRules

Uygulama sağlanmamışsa varsayılan SecurityRules hizmeti veya sağlanan uygulamayla ilişkilendirilmiş SecurityRules hizmeti.

1. örnek

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

2. örnek

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

Storage(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Depolama alanı hizmetini alır.

admin.storage(), varsayılan uygulamanın Storage hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş Storage hizmetine erişmek için admin.storage(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulama

Şunu döndürür:

depolama.Depolama

1. örnek

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

2. örnek

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

uygulama

İmza:

apps: (app.App | null)[]

SDK_VERSION

İmza:

SDK_VERSION: string