firebase-admin package

API không gian tên của Firebase (cũ).

Chức năng

Chức năng Sự miêu tả
tên ứng dụng)
appCheck(ứng dụng) Nhận dịch vụ AppCheck cho ứng dụng mặc định hoặc ứng dụng nhất định. admin.appCheck() có thể được gọi mà không có đối số để truy cập dịch vụ AppCheck của ứng dụng mặc định hoặc dưới dạng admin.appCheck(app) để truy cập dịch vụ AppCheck được liên kết với một ứng dụng cụ thể.
xác thực(ứng dụng) Nhận dịch vụ Xác thực cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.auth() có thể được gọi mà không cần đối số để truy cập dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng admin.auth(app) để truy cập dịch vụ Auth được liên kết với một ứng dụng cụ thể.
cơ sở dữ liệu (ứng dụng) Nhận dịch vụ Cơ sở dữ liệu cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.database() có thể được gọi mà không có đối số để truy cập dịch vụ Database của ứng dụng mặc định hoặc dưới dạng admin.database(app) để truy cập dịch vụ Database được liên kết với một ứng dụng cụ thể. admin.database cũng là một không gian tên có thể được sử dụng để truy cập các hằng số và phương thức chung được liên kết với dịch vụ Database .
firestore(ứng dụng)
khởi tạoApp(tùy chọn, tên)
cài đặt (ứng dụng) Nhận dịch vụ Cài đặt cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.installations() có thể được gọi mà không có đối số để truy cập dịch vụ Cài đặt của ứng dụng mặc định hoặc dưới dạng admin.installations(app) để truy cập dịch vụ Cài đặt được liên kết với một ứng dụng cụ thể.
instanceId(ứng dụng) Nhận dịch vụ InstanceId cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.instanceId() có thể được gọi mà không có đối số để truy cập dịch vụ InstanceId của ứng dụng mặc định hoặc dưới dạng admin.instanceId(app) để truy cập dịch vụ InstanceId được liên kết với một ứng dụng cụ thể.
máyHọc (ứng dụng) Nhận dịch vụ MachineLearning cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.machineLearning() có thể được gọi mà không có đối số để truy cập dịch vụ MachineLearning của ứng dụng mặc định hoặc dưới dạng admin.machineLearning(app) để truy cập dịch vụ MachineLearning được liên kết với một ứng dụng cụ thể.
nhắn tin (ứng dụng) Nhận dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.messaging() có thể được gọi mà không có đối số để truy cập dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập dịch vụ Messaging được liên kết với một ứng dụng cụ thể.
Quản lý dự án(ứng dụng) Nhận dịch vụ Quản lý dự án cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.projectManagement() có thể được gọi mà không có đối số để truy cập dịch vụ ProjectManagement của ứng dụng mặc định hoặc dưới dạng admin.projectManagement(app) để truy cập dịch vụ ProjectManagement được liên kết với một ứng dụng cụ thể.
remoteConfig(ứng dụng) Nhận dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.remoteConfig() có thể được gọi mà không cần đối số để truy cập dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng admin.remoteConfig(app) để truy cập dịch vụ RemoteConfig được liên kết với một ứng dụng cụ thể.
quy tắc bảo mật (ứng dụng) Nhận dịch vụ SecurityRules cho ứng dụng mặc định hoặc một ứng dụng nhất định. admin.securityRules() có thể được gọi mà không có đối số để truy cập dịch vụ SecurityRules của ứng dụng mặc định hoặc dưới dạng admin.securityRules(app) để truy cập dịch vụ SecurityRules được liên kết với một ứng dụng cụ thể.
lưu trữ (ứng dụng) Nhận dịch vụ lưu trữ cho ứng dụng mặc định hoặc ứng dụng nhất định. admin.storage() có thể được gọi mà không có đối số để truy cập dịch vụ Storage của ứng dụng mặc định hoặc dưới dạng admin.storage(app) để truy cập dịch vụ Storage được liên kết với một ứng dụng cụ thể.

Giao diện

Giao diện Sự miêu tả
Tùy chọn ứng dụng Các tùy chọn có sẵn để chuyển tới initizeApp() .
FirebaseArrayIndexLỗi Loại hỗn hợp bao gồm cả đối tượng FirebaseError và chỉ mục có thể được sử dụng để lấy mục bị lỗi.
FirebaseLỗi FirebaseError là một lớp con của đối tượng Error JavaScript tiêu chuẩn. Ngoài chuỗi thông báo và dấu vết ngăn xếp, nó còn chứa mã chuỗi.
Mã thông báo truy cập GoogleOAuth Giao diện cho mã thông báo truy cập Google OAuth 2.0.
Dịch vụTài khoản

Không gian tên

Không gian tên Sự miêu tả
ứng dụng
ứng dụngKiểm tra
xác thực
chứng chỉ
cơ sở dữ liệu
lò sưởi
cài đặt
Id cá thể
máyHọc tập
nhắn tin
quản lý dự án
cấu hình từ xa
an ninhRules
kho

Biến

Biến đổi Sự miêu tả
ứng dụng
SDK_VERSION

ứng dụng()

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tên sợi dây

Trả về:

ứng dụng.App

appCheck()

Nhận dịch vụ AppCheck cho ứng dụng mặc định hoặc ứng dụng nhất định.

admin.appCheck() có thể được gọi mà không có đối số để truy cập dịch vụ AppCheck của ứng dụng mặc định hoặc dưới dạng admin.appCheck(app) để truy cập dịch vụ AppCheck được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn để trả về dịch vụ AppCheck . Nếu không được cung cấp, dịch vụ AppCheck mặc định sẽ được trả về.

Trả về:

appCheck.AppCheck

Dịch vụ AppCheck mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ AppCheck được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

xác thực()

Nhận dịch vụ Xác thực cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.auth() có thể được gọi mà không cần đối số để truy cập dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng admin.auth(app) để truy cập dịch vụ Auth được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng

Trả về:

xác thực.Auth

ví dụ 1

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

Ví dụ 2

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

cơ sở dữ liệu()

Nhận dịch vụ Cơ sở dữ liệu cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.database() có thể được gọi mà không có đối số để truy cập dịch vụ Database của ứng dụng mặc định hoặc dưới dạng admin.database(app) để truy cập dịch vụ Database được liên kết với một ứng dụng cụ thể.

admin.database cũng là một không gian tên có thể được sử dụng để truy cập các hằng số và phương thức chung được liên kết với dịch vụ Database .

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng

Trả về:

cơ sở dữ liệu.Database

Dịch vụ Database mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Database được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

lò sưởi()

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng

Trả về:

_firestore.Firestore

khởi tạoỨng dụng()

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn ứng dụng
tên sợi dây

Trả về:

ứng dụng.App

cài đặt()

Nhận dịch vụ Cài đặt cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.installations() có thể được gọi mà không có đối số để truy cập dịch vụ Cài đặt của ứng dụng mặc định hoặc dưới dạng admin.installations(app) để truy cập dịch vụ Cài đặt được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ Installations sẽ quay trở lại. Nếu không được cung cấp, dịch vụ Cài Installations mặc định sẽ được trả về.

Trả về:

cài đặt.Cài đặt

Dịch vụ Cài Installations mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Installations được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

instanceId()

Nhận dịch vụ InstanceId cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.instanceId() có thể được gọi mà không có đối số để truy cập dịch vụ InstanceId của ứng dụng mặc định hoặc dưới dạng admin.instanceId(app) để truy cập dịch vụ InstanceId được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ InstanceId cần trả về. Nếu không được cung cấp, dịch vụ InstanceId mặc định sẽ được trả về.

Trả về:

instanceId.InstanceId

Dịch vụ InstanceId mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ InstanceId được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

máyHọc()

Nhận dịch vụ MachineLearning cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.machineLearning() có thể được gọi mà không có đối số để truy cập dịch vụ MachineLearning của ứng dụng mặc định hoặc dưới dạng admin.machineLearning(app) để truy cập dịch vụ MachineLearning được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ MachineLearning sẽ được trả về. Nếu không được cung cấp, dịch vụ MachineLearning mặc định sẽ được trả về.

Trả về:

machineLearning.MachineLearning

Dịch vụ MachineLearning mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ MachineLearning được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

nhắn tin()

Nhận dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.messaging() có thể được gọi mà không cần đối số để truy cập dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập dịch vụ Messaging được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ Messaging sẽ quay trở lại. Nếu không được cung cấp, dịch vụ Messaging mặc định sẽ được trả về.

Trả về:

tin nhắn.Messaging

Dịch vụ Messaging mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Messaging được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

quản lý dự án()

Nhận dịch vụ Quản lý dự án cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.projectManagement() có thể được gọi mà không có đối số để truy cập dịch vụ ProjectManagement của ứng dụng mặc định hoặc dưới dạng admin.projectManagement(app) để truy cập dịch vụ ProjectManagement được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn có dịch vụ ProjectManagement sẽ được trả về. Nếu không được cung cấp, dịch vụ ProjectManagement mặc định sẽ được trả về. *

Trả về:

quản lý dự án.Quản lý dự án

Dịch vụ ProjectManagement mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ ProjectManagement được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

remoteConfig()

Nhận dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.remoteConfig() có thể được gọi mà không cần đối số để truy cập dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng admin.remoteConfig(app) để truy cập dịch vụ RemoteConfig được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn để trả về dịch vụ RemoteConfig . Nếu không được cung cấp, dịch vụ RemoteConfig mặc định sẽ được trả về.

Trả về:

remoteConfig.RemoteConfig

Dịch vụ RemoteConfig mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ RemoteConfig được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

securityRules()

Nhận dịch vụ SecurityRules cho ứng dụng mặc định hoặc một ứng dụng nhất định.

admin.securityRules() có thể được gọi mà không có đối số để truy cập dịch vụ SecurityRules của ứng dụng mặc định hoặc dưới dạng admin.securityRules(app) để truy cập dịch vụ SecurityRules được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Ứng dụng tùy chọn để trả lại dịch vụ SecurityRules . Nếu không được cung cấp, dịch vụ SecurityRules mặc định sẽ được trả về.

Trả về:

securityRules.SecurityRules

Dịch vụ SecurityRules mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ SecurityRules được liên kết với ứng dụng được cung cấp.

ví dụ 1

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

Ví dụ 2

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

kho()

Nhận dịch vụ lưu trữ cho ứng dụng mặc định hoặc ứng dụng nhất định.

admin.storage() có thể được gọi mà không có đối số để truy cập dịch vụ Storage của ứng dụng mặc định hoặc dưới dạng admin.storage(app) để truy cập dịch vụ Storage được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng

Trả về:

lưu trữ.Storage

ví dụ 1

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

Ví dụ 2

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

ứng dụng

Chữ ký:

apps: (app.App | null)[]

SDK_VERSION

Chữ ký:

SDK_VERSION: string