firebase-admin package

Firebase namespace API (میراث).

کارکرد

تابع شرح
نام برنامه)
appCheck (برنامه) سرویس AppCheck را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.appCheck() می توان بدون هیچ آرگومان برای دسترسی به سرویس AppCheck برنامه پیش فرض یا به عنوان admin.appCheck(app) برای دسترسی به سرویس AppCheck مرتبط با یک برنامه خاص فراخوانی کرد.
اعتبار (برنامه) سرویس Auth را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.auth() می توان بدون هیچ آرگومان برای دسترسی به سرویس Auth برنامه پیش فرض یا به عنوان admin.auth(app) برای دسترسی به سرویس Auth مرتبط با یک برنامه خاص فراخوانی کرد.
پایگاه داده (برنامه) سرویس پایگاه داده را برای برنامه پیش فرض یا یک برنامه خاص دریافت می کند. admin.database() می توان بدون هیچ آرگومان برای دسترسی به سرویس Database برنامه پیش فرض یا به عنوان admin.database(app) برای دسترسی به سرویس Database مرتبط با یک برنامه خاص فراخوانی کرد. admin.database همچنین یک فضای نام است که می تواند برای دسترسی به ثابت های جهانی و روش های مرتبط با سرویس Database استفاده شود.
firestore (برنامه)
InitializeApp (گزینه ها، نام)
نصب (برنامه) سرویس Installations را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.installations() می توان بدون هیچ آرگومان برای دسترسی به سرویس نصب برنامه پیش فرض یا به عنوان admin.installations(app) برای دسترسی به سرویس نصب مرتبط با یک برنامه خاص فراخوانی کرد.
شناسه نمونه (برنامه) سرویس InstanceId را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.instanceId() می توان بدون آرگومان برای دسترسی به سرویس InstanceId برنامه پیش فرض یا به عنوان admin.instanceId(app) برای دسترسی به سرویس InstanceId مرتبط با یک برنامه خاص فراخوانی کرد.
machineLearning (برنامه) سرویس MachineLearning را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.machineLearning() می توان بدون هیچ آرگومان برای دسترسی به سرویس MachineLearning برنامه پیش فرض یا به عنوان admin.machineLearning(app) برای دسترسی به سرویس MachineLearning مرتبط با یک برنامه خاص فراخوانی کرد.
پیام رسانی (برنامه) سرویس پیام‌رسانی را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.messaging() می توان بدون هیچ آرگومان برای دسترسی به سرویس Messaging برنامه پیش فرض یا به عنوان admin.messaging(app) برای دسترسی به سرویس Messaging مرتبط با یک برنامه خاص فراخوانی کرد.
مدیریت پروژه (برنامه) سرویس ProjectManagement را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.projectManagement() می توان بدون هیچ آرگومان برای دسترسی به سرویس ProjectManagement برنامه پیش فرض، یا به عنوان admin.projectManagement(app) برای دسترسی به سرویس ProjectManagement مرتبط با یک برنامه خاص فراخوانی کرد.
RemoteConfig (برنامه) سرویس RemoteConfig را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.remoteConfig() می توان بدون هیچ آرگومان برای دسترسی به سرویس RemoteConfig برنامه پیش فرض یا به عنوان admin.remoteConfig(app) برای دسترسی به سرویس RemoteConfig مرتبط با یک برنامه خاص فراخوانی کرد.
قوانین امنیتی (برنامه) سرویس SecurityRules را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.securityRules() می توان بدون هیچ آرگومان برای دسترسی به سرویس SecurityRules برنامه پیش فرض، یا به عنوان admin.securityRules(app) برای دسترسی به سرویس SecurityRules مرتبط با یک برنامه خاص فراخوانی کرد.
ذخیره سازی (برنامه) سرویس فضای ذخیره‌سازی را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.storage() می توان بدون هیچ آرگومان برای دسترسی به سرویس Storage برنامه پیش فرض یا به عنوان admin.storage(app) برای دسترسی به سرویس Storage مرتبط با یک برنامه خاص فراخوانی کرد.

رابط ها

رابط شرح
AppOptions گزینه های موجود برای انتقال به InitializeApp() .
FirebaseArrayIndexError نوع ترکیبی که شامل یک شی FirebaseError و یک شاخص است که می تواند برای دریافت آیتم خطا استفاده شود.
FirebaseError FirebaseError یک زیر کلاس از شی استاندارد JavaScript Error است. علاوه بر یک رشته پیام و ردیابی پشته، حاوی یک کد رشته است.
GoogleOAuthAccessToken رابط برای توکن‌های دسترسی Google OAuth 2.0.
حساب سرویس

فضاهای نام

فضای نام شرح
برنامه
appCheck
اعتبار
اعتبار
پایگاه داده
آتش نشانی
تاسیسات
شناسه نمونه
فراگیری ماشین
پیام رسانی
مدیریت پروژه
remoteConfig
قوانین امنیتی
ذخیره سازی

متغیرها

متغیر شرح
برنامه ها
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);

auth()

سرویس Auth را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

admin.auth() می توان بدون هیچ آرگومان برای دسترسی به سرویس Auth برنامه پیش فرض یا به عنوان admin.auth(app) برای دسترسی به سرویس Auth مرتبط با یک برنامه خاص فراخوانی کرد.

امضا:

export declare function auth(app?: App): auth.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);

firestore()

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه

برمی گرداند:

_firestore.Firestore

InitializeApp()

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
گزینه ها AppOptions
نام رشته

برمی گرداند:

برنامه.برنامه

تاسیسات ()

سرویس Installations را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

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()

سرویس InstanceId را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

admin.instanceId() می توان بدون آرگومان برای دسترسی به سرویس InstanceId برنامه پیش فرض یا به عنوان admin.instanceId(app) برای دسترسی به سرویس InstanceId مرتبط با یک برنامه خاص فراخوانی کرد.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه برنامه اختیاری که سرویس 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()

سرویس 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);

Security Rules()

سرویس 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