Bộ nhớ đám mây cho Firebase
Chức năng
Chức năng | Sự miêu tả |
---|---|
chức năng (ứng dụng, ...) | |
getStorage(ứng dụng, xôUrl) | Nhận phiên bản FirebaseStorage cho ứng dụng Firebase nhất định. |
chức năng (lưu trữ, ...) | |
connectStorageEmulator(lưu trữ, máy chủ, cổng, tùy chọn) | Sửa đổi phiên bản FirebaseStorage này để giao tiếp với trình mô phỏng Cloud Storage. |
ref(lưu trữ, url) | Trả về StorageReference cho url đã cho. |
hàm(ref, ...) | |
xóaObject(ref) | Xóa đối tượng tại vị trí này. |
getBlob(ref, maxDownloadSizeBytes) | Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng. Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors API này không có sẵn trong Node. |
getBytes(ref, maxDownloadSizeBytes) | Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng. Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors |
getDownloadURL(ref) | Trả về URL tải xuống cho StorageReference đã cho . |
getMetadata(ref) | Promise giải quyết bằng siêu dữ liệu cho đối tượng này. Nếu đối tượng này không tồn tại hoặc không thể truy xuất siêu dữ liệu thì lời hứa sẽ bị từ chối. |
getStream(ref, maxDownloadSizeBytes) | Tải xuống dữ liệu tại vị trí của đối tượng. Phát sinh sự kiện lỗi nếu không tìm thấy đối tượng. API này chỉ khả dụng trong Node. |
danh sách (ref, tùy chọn) | Liệt kê các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này. API danh sách chỉ khả dụng cho Quy tắc Firebase phiên bản 2. GCS là một cửa hàng key-blob. Bộ lưu trữ Firebase áp đặt ngữ nghĩa của cấu trúc thư mục được phân tách bằng '/'. Hãy tham khảo API danh sách của GCS nếu bạn muốn tìm hiểu thêm. Để tuân thủ Ngữ nghĩa của Quy tắc Firebase, Bộ lưu trữ Firebase không hỗ trợ các đối tượng có đường dẫn kết thúc bằng "/" hoặc chứa hai "/" liên tiếp. API danh sách lưu trữ Firebase sẽ lọc các đối tượng không được hỗ trợ này. list() có thể thất bại nếu có quá nhiều đối tượng không được hỗ trợ trong nhóm. |
danh sáchTất cả(ref) | Liệt kê tất cả các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này. Đây là một phương thức trợ giúp để gọi list() nhiều lần cho đến khi không còn kết quả nào nữa. Kích thước phân trang mặc định là 1000. Lưu ý: Kết quả có thể không nhất quán nếu các đối tượng bị thay đổi trong khi thao tác này đang chạy. Cảnh báo: listAll có thể tiêu tốn quá nhiều tài nguyên nếu có quá nhiều kết quả. |
updateMetadata(ref, siêu dữ liệu) | Cập nhật siêu dữ liệu cho đối tượng này. |
uploadBytes(ref, dữ liệu, siêu dữ liệu) | Tải dữ liệu lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được. |
uploadBytesResumable(ref, dữ liệu, siêu dữ liệu) | Tải dữ liệu lên vị trí của đối tượng này. Quá trình tải lên có thể bị tạm dừng và tiếp tục, đồng thời hiển thị các cập nhật tiến trình. |
uploadString(ref, giá trị, định dạng, siêu dữ liệu) | Tải một chuỗi lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được. |
hàm(storageOrRef, ...) | |
ref(storageOrRef, đường dẫn) | Trả về StorageReference cho đường dẫn đã cho trong nhóm mặc định. |
Các lớp học
Lớp học | Sự miêu tả |
---|---|
Lỗi lưu trữ | Đã xảy ra lỗi do SDK lưu trữ Firebase trả về. |
Bảng liệt kê
liệt kê | Sự miêu tả |
---|---|
Lưu trữMã lỗi | Mã lỗi có thể được gắn vào đối tượng StorageError . |
Giao diện
Giao diện | Sự miêu tả |
---|---|
Bộ nhớ Firebase | Một phiên bản Lưu trữ Firebase. |
Siêu dữ liệu đầy đủ | Tập hợp đầy đủ siêu dữ liệu đối tượng, bao gồm các thuộc tính chỉ đọc. |
Danh sáchTùy chọn | list() chấp nhận. |
Danh sáchKết quả | Kết quả trả về bởi list(). |
Siêu dữ liệu có thể cài đặt | Siêu dữ liệu đối tượng có thể được đặt bất cứ lúc nào. |
Người quan sát lưu trữ | Trình quan sát luồng cho Bộ lưu trữ Firebase. |
Lưu trữTham khảo | Biểu thị tham chiếu đến đối tượng Google Cloud Storage. Nhà phát triển có thể tải lên, tải xuống và xóa các đối tượng cũng như lấy/đặt siêu dữ liệu đối tượng. |
Tải lên siêu dữ liệu | Siêu dữ liệu đối tượng có thể được đặt khi tải lên. |
Tải lênKết quả | Kết quả được trả về từ quá trình tải lên không thể tiếp tục. |
Nhiệm vụ tải lên | Thể hiện quá trình tải lên một đối tượng. Cho phép bạn theo dõi và quản lý việc tải lên. |
Tải lênNhiệm vụSnapshot | Giữ dữ liệu về trạng thái hiện tại của tác vụ tải lên. |
Biến
Biến đổi | Sự miêu tả |
---|---|
Định dạng chuỗi | Bảng liệt kê các định dạng chuỗi có thể tải lên. |
Nhập bí danh
Nhập bí danh | Sự miêu tả |
---|---|
Định dạng chuỗi | Bảng liệt kê các định dạng chuỗi có thể tải lên. |
Sự kiện nhiệm vụ | Một sự kiện được kích hoạt trong một nhiệm vụ. |
Trạng thái nhiệm vụ | Thể hiện trạng thái hiện tại của quá trình tải lên đang chạy. |
chức năng (ứng dụng, ...)
getStorage(ứng dụng, xôUrl)
Nhận phiên bản FirebaseStorage cho ứng dụng Firebase nhất định.
Chữ ký:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
ứng dụng | Ứng dụng Firebase | Ứng dụng Firebase để lấy phiên bản FirebaseStorage . |
xôUrl | sợi dây | Url gs:// vào Nhóm lưu trữ Firebase của bạn. Nếu không được thông qua, hãy sử dụng Nhóm lưu trữ mặc định của ứng dụng. |
Trả về:
Một phiên bản FirebaseStorage .
chức năng (lưu trữ, ...)
connectStorageEmulator(lưu trữ, máy chủ, cổng, tùy chọn)
Sửa đổi phiên bản FirebaseStorage này để giao tiếp với trình mô phỏng Cloud Storage.
Chữ ký:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
kho | Bộ nhớ Firebase | Phiên bản FirebaseStorage |
chủ nhà | sợi dây | Máy chủ mô phỏng (ví dụ: localhost) |
Hải cảng | con số | Cổng giả lập (ví dụ: 5001) |
tùy chọn | { mockUserToken?: EmulatorMockTokenOptions | sợi dây; } | Tùy chọn giả lập. options.mockUserToken là mã thông báo xác thực giả được sử dụng để kiểm tra đơn vị Quy tắc bảo mật. |
Trả về:
trống rỗng
ref(lưu trữ, url)
Trả về StorageReference cho url đã cho.
Chữ ký:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
kho | Bộ nhớ Firebase | Phiên bản FirebaseStorage . |
địa chỉ | sợi dây | URL. Nếu trống, trả về tham chiếu gốc. |
Trả về:
hàm(ref, ...)
xóaObject(ref)
Xóa đối tượng tại vị trí này.
Chữ ký:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference cho đối tượng cần xóa. |
Trả về:
Hứa<void>
Một Promise
sẽ được giải quyết nếu việc xóa thành công.
getBlob(ref, maxDownloadSizeBytes)
Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng.
Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors
API này không có sẵn trong Node.
Chữ ký:
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi dữ liệu sẽ được tải xuống. |
maxDownloadSizeByte | con số | Nếu được đặt, kích thước tối đa được phép tính bằng byte để truy xuất. |
Trả về:
Hứa<Blob>
Lời hứa được giải quyết bằng Blob chứa byte của đối tượng
getBytes(ref, maxDownloadSizeBytes)
Tải xuống dữ liệu tại vị trí của đối tượng. Trả về lỗi nếu không tìm thấy đối tượng.
Để sử dụng chức năng này, bạn phải đưa nguồn gốc ứng dụng của mình vào danh sách trắng trong nhóm Lưu trữ đám mây. Xem thêm https://cloud.google.com/storage/docs/configuring-cors
Chữ ký:
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi dữ liệu sẽ được tải xuống. |
maxDownloadSizeByte | con số | Nếu được đặt, kích thước tối đa được phép tính bằng byte để truy xuất. |
Trả về:
Lời hứa<ArrayBuffer>
Lời hứa chứa byte của đối tượng
getDownloadURL(ref)
Trả về URL tải xuống cho StorageReference đã cho .
Chữ ký:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference để lấy URL tải xuống. |
Trả về:
Hứa<string>
Promise
được giải quyết bằng URL tải xuống cho đối tượng này.
getMetadata(ref)
Promise
giải quyết bằng siêu dữ liệu cho đối tượng này. Nếu đối tượng này không tồn tại hoặc không thể truy xuất siêu dữ liệu thì lời hứa sẽ bị từ chối.
Chữ ký:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference để lấy siêu dữ liệu từ đó. |
Trả về:
Hứa < Siêu dữ liệu đầy đủ >
getStream(ref, maxDownloadSizeBytes)
Tải xuống dữ liệu tại vị trí của đối tượng. Phát sinh sự kiện lỗi nếu không tìm thấy đối tượng.
API này chỉ khả dụng trong Node.
Chữ ký:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi dữ liệu sẽ được tải xuống. |
maxDownloadSizeByte | con số | Nếu được đặt, kích thước tối đa được phép tính bằng byte để truy xuất. |
Trả về:
NodeJS.ReadableStream
Một luồng có dữ liệu của đối tượng dưới dạng byte
danh sách (ref, tùy chọn)
Liệt kê các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này.
API danh sách chỉ khả dụng cho Quy tắc Firebase phiên bản 2.
GCS là một cửa hàng key-blob. Bộ lưu trữ Firebase áp đặt ngữ nghĩa của cấu trúc thư mục được phân tách bằng '/'. Hãy tham khảo API danh sách của GCS nếu bạn muốn tìm hiểu thêm.
Để tuân thủ Ngữ nghĩa của Quy tắc Firebase, Bộ lưu trữ Firebase không hỗ trợ các đối tượng có đường dẫn kết thúc bằng "/" hoặc chứa hai "/" liên tiếp. API danh sách lưu trữ Firebase sẽ lọc các đối tượng không được hỗ trợ này. list() có thể thất bại nếu có quá nhiều đối tượng không được hỗ trợ trong nhóm.
Chữ ký:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference để lấy danh sách từ đó. |
tùy chọn | Danh sáchTùy chọn | Xem ListOptions để biết chi tiết. |
Trả về:
Lời hứa< Danh sáchKết quả >
Một Promise
được giải quyết bằng các mục và tiền tố. prefixes
chứa tham chiếu đến các thư mục con và items
tham chiếu đến các đối tượng trong thư mục này. nextPageToken
có thể được sử dụng để nhận phần còn lại của kết quả.
danh sáchTất cả(ref)
Liệt kê tất cả các mục (tệp) và tiền tố (thư mục) trong tham chiếu lưu trữ này.
Đây là một phương thức trợ giúp để gọi list() nhiều lần cho đến khi không còn kết quả nào nữa. Kích thước phân trang mặc định là 1000.
Chữ ký:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference để lấy danh sách từ đó. |
Trả về:
Lời hứa< Danh sáchKết quả >
Promise
giải quyết tất cả các mục và tiền tố trong tham chiếu lưu trữ hiện tại. prefixes
chứa tham chiếu đến thư mục con và items
chứa tham chiếu đến đối tượng trong thư mục này. nextPageToken
không bao giờ được trả lại.
updateMetadata(ref, siêu dữ liệu)
Cập nhật siêu dữ liệu cho đối tượng này.
Chữ ký:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference để cập nhật siêu dữ liệu cho. |
metadata | Siêu dữ liệu có thể cài đặt | Siêu dữ liệu mới cho đối tượng. Chỉ những giá trị đã được đặt rõ ràng mới được thay đổi. Việc đặt giá trị thành null một cách rõ ràng sẽ xóa siêu dữ liệu. |
Trả về:
Hứa < Siêu dữ liệu đầy đủ >
Promise
được giải quyết bằng siêu dữ liệu mới cho đối tượng này.
uploadBytes(ref, dữ liệu, siêu dữ liệu)
Tải dữ liệu lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được.
Chữ ký:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi dữ liệu sẽ được tải lên. |
dữ liệu | Blob | Uint8Array | Bộ đệm mảng | Dữ liệu để tải lên. |
metadata | Tải lên siêu dữ liệu | Siêu dữ liệu để tải lên dữ liệu. |
Trả về:
Lời hứa< Tải lênKết quả >
Lời hứa chứa Kết quả tải lên
uploadBytesResumable(ref, dữ liệu, siêu dữ liệu)
Tải dữ liệu lên vị trí của đối tượng này. Quá trình tải lên có thể bị tạm dừng và tiếp tục, đồng thời hiển thị các cập nhật tiến trình.
Chữ ký:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi dữ liệu sẽ được tải lên. |
dữ liệu | Blob | Uint8Array | Bộ đệm mảng | Dữ liệu để tải lên. |
metadata | Tải lên siêu dữ liệu | Siêu dữ liệu để tải lên dữ liệu. |
Trả về:
Nhiệm vụ tải lên
uploadString(ref, giá trị, định dạng, siêu dữ liệu)
Tải một chuỗi lên vị trí của đối tượng này. Việc tải lên không thể tiếp tục được.
Chữ ký:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
giới thiệu | Lưu trữTham khảo | StorageReference nơi chuỗi sẽ được tải lên. |
giá trị | sợi dây | Chuỗi để tải lên. |
định dạng | Định dạng chuỗi | Định dạng của chuỗi để tải lên. |
metadata | Tải lên siêu dữ liệu | Siêu dữ liệu cho chuỗi để tải lên. |
Trả về:
Lời hứa< Tải lênKết quả >
Lời hứa chứa Kết quả tải lên
hàm(storageOrRef, ...)
ref(storageOrRef, đường dẫn)
Trả về StorageReference cho đường dẫn đã cho trong nhóm mặc định.
Chữ ký:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
Thông số
Tham số | Kiểu | Sự miêu tả |
---|---|---|
lưu trữOrRef | Lưu trữ Firebase | Lưu trữTham khảo | FirebaseStorage hoặc StorageReference . |
con đường | sợi dây |
Trả về:
Định dạng chuỗi
Bảng liệt kê các định dạng chuỗi có thể tải lên.
Chữ ký:
StringFormat: {
readonly RAW: "raw";
readonly BASE64: "base64";
readonly BASE64URL: "base64url";
readonly DATA_URL: "data_url";
}
Định dạng chuỗi
Bảng liệt kê các định dạng chuỗi có thể tải lên.
Chữ ký:
export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
Sự kiện nhiệm vụ
Một sự kiện được kích hoạt trong một nhiệm vụ.
Chữ ký:
export declare type TaskEvent = 'state_changed';
Trạng thái nhiệm vụ
Thể hiện trạng thái hiện tại của quá trình tải lên đang chạy.
Chữ ký:
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
Lưu trữMã lỗi
Mã lỗi có thể được gắn vào đối tượng StorageError
.
Chữ ký:
export declare enum StorageErrorCode
Thành viên điều tra
Thành viên | Giá trị | Sự miêu tả |
---|---|---|
APP_DELETED | "app-deleted" | |
BUCKET_NOT_FOUND | "bucket-not-found" | |
ĐÃ HỦY | "canceled" | |
KHÔNG THỂ_SLICE_BLOB | "cannot-slice-blob" | |
LỖI BÊN TRONG | "internal-error" | |
INVALID_ARGUMENT | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
INVALID_FORMAT | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
INVALID_URL | "invalid-url" | |
KHÔNG_DEFAULT_BUCKET | "no-default-bucket" | |
KHÔNG_DOWNLOAD_URL | "no-download-url" | |
ĐỐI TƯỢNG_NOT_FOUND | "object-not-found" | |
DỰ ÁN_NOT_FOUND | "project-not-found" | |
QUOTA_EXCEEDED | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" | |
KHÔNG ĐƯỢC XÁC THỰC | "unauthenticated" | |
KHÔNG ĐƯỢC PHÉP | "unauthorized" | |
UNAUTHORIZED_APP | "unauthorized-app" | |
KHÔNG XÁC ĐỊNH | "unknown" | |
KHÔNG HỖ TRỢ_ENVIRONMENT | "unsupported-environment" |