Penyimpanan Cloud untuk Firebase
Fungsi
Fungsi | Keterangan |
---|---|
fungsi(aplikasi, ...) | |
getStorage(aplikasi, bucketUrl) | Mendapatkan instance FirebaseStorage untuk aplikasi Firebase tertentu. |
fungsi (penyimpanan, ...) | |
connectStorageEmulator (penyimpanan, host, port, opsi) | Ubah instance FirebaseStorage ini untuk berkomunikasi dengan emulator Cloud Storage. |
ref(penyimpanan, url) | Mengembalikan StorageReference untuk url yang diberikan. |
fungsi(ref, ...) | |
hapusObjek(ref) | Menghapus objek di lokasi ini. |
getBlob(ref, maxDownloadSizeBytes) | Mengunduh data di lokasi objek. Mengembalikan kesalahan jika objek tidak ditemukan. Untuk menggunakan fungsi ini, Anda harus memasukkan asal aplikasi Anda ke dalam daftar putih di bucket Cloud Storage Anda. Lihat juga https://cloud.google.com/storage/docs/configuring-cors API ini tidak tersedia di Node.js. |
getBytes(ref, maxDownloadSizeBytes) | Mengunduh data di lokasi objek. Mengembalikan kesalahan jika objek tidak ditemukan. Untuk menggunakan fungsi ini, Anda harus memasukkan asal aplikasi Anda ke dalam daftar putih di bucket Cloud Storage Anda. Lihat juga https://cloud.google.com/storage/docs/configuring-cors |
dapatkan UnduhURL (ref) | Mengembalikan URL unduhan untuk StorageReference yang diberikan . |
dapatkan Metadata (ref) | Promise yang diselesaikan dengan metadata untuk objek ini. Jika objek ini tidak ada atau metadata tidak dapat diambil, janji akan ditolak. |
getStream(ref, maxDownloadSizeBytes) | Mengunduh data di lokasi objek. Memunculkan event error jika objek tidak ditemukan. API ini hanya tersedia di Node.js. |
daftar (ref, opsi) | Daftar item (file) dan awalan (folder) di bawah referensi penyimpanan ini. Daftar API hanya tersedia untuk Aturan Firebase Versi 2. GCS adalah toko gumpalan kunci. Firebase Storage menerapkan semantik struktur folder yang dibatasi '/'. Lihat List API GCS jika Anda ingin mempelajari lebih lanjut. Untuk mematuhi Semantik Aturan Firebase, Firebase Storage tidak mendukung objek yang jalurnya diakhiri dengan "/" atau berisi dua "/" yang berurutan. Firebase Storage List API akan memfilter objek yang tidak didukung ini. list() mungkin gagal jika ada terlalu banyak objek yang tidak didukung di dalam bucket. |
daftarSemua(ref) | Cantumkan semua item (file) dan awalan (folder) di bawah referensi penyimpanan ini. Ini adalah metode pembantu untuk memanggil list() berulang kali hingga tidak ada hasil lagi. Ukuran penomoran halaman default adalah 1000. Catatan: Hasilnya mungkin tidak konsisten jika objek diubah saat operasi ini berjalan. Peringatan: listAll berpotensi menghabiskan terlalu banyak sumber daya jika hasilnya terlalu banyak. |
perbaruiMetadata(ref, metadata) | Memperbarui metadata untuk objek ini. |
uploadBytes(ref, data, metadata) | Mengunggah data ke lokasi objek ini. Pengunggahan tidak dapat dilanjutkan. |
uploadBytesResumable(ref, data, metadata) | Mengunggah data ke lokasi objek ini. Pengunggahan dapat dijeda dan dilanjutkan, serta menampilkan pembaruan kemajuan. |
uploadString(ref, nilai, format, metadata) | Mengunggah string ke lokasi objek ini. Pengunggahan tidak dapat dilanjutkan. |
fungsi(penyimpananOrRef, ...) | |
ref(storageOrRef, jalur) | Mengembalikan StorageReference untuk jalur tertentu di bucket default. |
Kelas
Kelas | Keterangan |
---|---|
Kesalahan Penyimpanan | Kesalahan yang ditampilkan oleh Firebase Storage SDK. |
Pencacahan
Pencacahan | Keterangan |
---|---|
Kode Kesalahan Penyimpanan | Kode kesalahan yang dapat dilampirkan ke objek StorageError . |
Antarmuka
Antarmuka | Keterangan |
---|---|
Penyimpanan Firebase | Sebuah instance Firebase Storage. |
Metadata Penuh | Kumpulan lengkap metadata objek, termasuk properti hanya-baca. |
DaftarOpsi | Opsi list() menerima. |
DaftarHasil | Hasil dikembalikan oleh daftar(). |
Metadata yang Dapat Diatur | Metadata objek yang dapat diatur kapan saja. |
Pengamat Penyimpanan | Pengamat aliran untuk Firebase Storage. |
Referensi Penyimpanan | Mewakili referensi ke objek Google Cloud Storage. Pengembang dapat mengunggah, mengunduh, dan menghapus objek, serta mendapatkan/mengatur metadata objek. |
Unggah Metadata | Metadata objek yang dapat diatur saat diunggah. |
Hasil Unggah | Hasil yang dikembalikan dari unggahan yang tidak dapat dilanjutkan. |
UnggahTugas | Mewakili proses mengunggah suatu objek. Memungkinkan Anda memantau dan mengelola unggahan. |
UnggahTugasSnapshot | Menyimpan data tentang status tugas pengunggahan saat ini. |
Variabel
Variabel | Keterangan |
---|---|
Format String | Pencacahan kemungkinan format string untuk diunggah. |
Ketik Alias
Ketik Alias | Keterangan |
---|---|
Format String | Pencacahan kemungkinan format string untuk diunggah. |
Acara Tugas | Suatu peristiwa yang dipicu pada suatu tugas. |
Status Tugas | Mewakili status unggahan yang sedang berjalan. |
fungsi(aplikasi, ...)
getStorage(aplikasi, bucketUrl)
Mendapatkan instance FirebaseStorage untuk aplikasi Firebase tertentu.
Tanda tangan:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi Firebase | Aplikasi Firebase untuk mendapatkan instance FirebaseStorage . |
emberUrl | rangkaian | Url gs:// ke Firebase Storage Bucket Anda. Jika tidak lolos, gunakan Keranjang Penyimpanan default aplikasi. |
Pengembalian:
Contoh FirebaseStorage .
fungsi (penyimpanan, ...)
connectStorageEmulator (penyimpanan, host, port, opsi)
Ubah instance FirebaseStorage ini untuk berkomunikasi dengan emulator Cloud Storage.
Tanda tangan:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
penyimpanan | Penyimpanan Firebase | Contoh FirebaseStorage |
tuan rumah | rangkaian | Host emulator (misal: localhost) |
pelabuhan | nomor | Port emulator (misal: 5001) |
pilihan | { mockUserToken?: EmulatorMockTokenOptions | rangkaian; } | Opsi emulator. options.mockUserToken adalah token autentikasi tiruan yang digunakan untuk pengujian unit Aturan Keamanan. |
Pengembalian:
ruang kosong
ref(penyimpanan, url)
Mengembalikan StorageReference untuk url yang diberikan.
Tanda tangan:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
penyimpanan | Penyimpanan Firebase | Contoh FirebaseStorage . |
url | rangkaian | URL. Jika kosong, kembalikan referensi root. |
Pengembalian:
fungsi(ref, ...)
hapusObjek(ref)
Menghapus objek di lokasi ini.
Tanda tangan:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk objek yang akan dihapus. |
Pengembalian:
Janji<batal>
Promise
yang diselesaikan jika penghapusan berhasil.
getBlob(ref, maxDownloadSizeBytes)
Mengunduh data di lokasi objek. Mengembalikan kesalahan jika objek tidak ditemukan.
Untuk menggunakan fungsi ini, Anda harus memasukkan asal aplikasi Anda ke dalam daftar putih di bucket Cloud Storage Anda. Lihat juga https://cloud.google.com/storage/docs/configuring-cors
API ini tidak tersedia di Node.js.
Tanda tangan:
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat data harus diunduh. |
maxDownloadSizeBytes | nomor | Jika disetel, ukuran maksimum yang diperbolehkan dalam byte untuk diambil. |
Pengembalian:
Janji<Gumpalan>
Janji yang diselesaikan dengan Blob yang berisi byte objek
getBytes(ref, maxDownloadSizeBytes)
Mengunduh data di lokasi objek. Mengembalikan kesalahan jika objek tidak ditemukan.
Untuk menggunakan fungsi ini, Anda harus memasukkan asal aplikasi Anda ke dalam daftar putih di bucket Cloud Storage Anda. Lihat juga https://cloud.google.com/storage/docs/configuring-cors
Tanda tangan:
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat data harus diunduh. |
maxDownloadSizeBytes | nomor | Jika disetel, ukuran maksimum yang diperbolehkan dalam byte untuk diambil. |
Pengembalian:
Janji<ArrayBuffer>
Janji yang berisi byte objek
dapatkan UnduhURL (ref)
Mengembalikan URL unduhan untuk StorageReference yang diberikan .
Tanda tangan:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk mendapatkan URL unduhan. |
Pengembalian:
Janji<string>
Promise
yang diselesaikan dengan URL unduhan untuk objek ini.
dapatkan Metadata (ref)
Promise
yang diselesaikan dengan metadata untuk objek ini. Jika objek ini tidak ada atau metadata tidak dapat diambil, janji akan ditolak.
Tanda tangan:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk mendapatkan metadata. |
Pengembalian:
Janji< Metadata Penuh >
getStream(ref, maxDownloadSizeBytes)
Mengunduh data di lokasi objek. Memunculkan event error jika objek tidak ditemukan.
API ini hanya tersedia di Node.js.
Tanda tangan:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat data harus diunduh. |
maxDownloadSizeBytes | nomor | Jika disetel, ukuran maksimum yang diperbolehkan dalam byte untuk diambil. |
Pengembalian:
NodeJS.ReadableStream
Aliran dengan data objek sebagai byte
daftar (ref, opsi)
Daftar item (file) dan awalan (folder) di bawah referensi penyimpanan ini.
Daftar API hanya tersedia untuk Aturan Firebase Versi 2.
GCS adalah toko gumpalan kunci. Firebase Storage menerapkan semantik struktur folder yang dibatasi '/'. Lihat List API GCS jika Anda ingin mempelajari lebih lanjut.
Untuk mematuhi Semantik Aturan Firebase, Firebase Storage tidak mendukung objek yang jalurnya diakhiri dengan "/" atau berisi dua "/" yang berurutan. Firebase Storage List API akan memfilter objek yang tidak didukung ini. list() mungkin gagal jika ada terlalu banyak objek yang tidak didukung di dalam bucket.
Tanda tangan:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk mendapatkan daftarnya. |
pilihan | DaftarOpsi | Lihat ListOptions untuk detailnya. |
Pengembalian:
Janji< DaftarHasil >
Promise
yang diselesaikan dengan item dan awalan. prefixes
berisi referensi ke sub-folder dan items
berisi referensi ke objek dalam folder ini. nextPageToken
dapat digunakan untuk mendapatkan hasil lainnya.
daftarSemua(ref)
Cantumkan semua item (file) dan awalan (folder) di bawah referensi penyimpanan ini.
Ini adalah metode pembantu untuk memanggil list() berulang kali hingga tidak ada hasil lagi. Ukuran penomoran halaman default adalah 1000.
Tanda tangan:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk mendapatkan daftarnya. |
Pengembalian:
Janji< DaftarHasil >
Promise
yang diselesaikan dengan semua item dan awalan berdasarkan referensi penyimpanan saat ini. prefixes
berisi referensi ke subdirektori dan items
berisi referensi ke objek dalam folder ini. nextPageToken
tidak pernah dikembalikan.
perbaruiMetadata(ref, metadata)
Memperbarui metadata untuk objek ini.
Tanda tangan:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference untuk memperbarui metadata. |
metadata | Metadata yang Dapat Diatur | Metadata baru untuk objek tersebut. Hanya nilai yang telah ditetapkan secara eksplisit yang akan diubah. Menetapkan nilai secara eksplisit ke null akan menghapus metadata. |
Pengembalian:
Janji< Metadata Penuh >
Promise
yang diselesaikan dengan metadata baru untuk objek ini.
uploadBytes(ref, data, metadata)
Mengunggah data ke lokasi objek ini. Pengunggahan tidak dapat dilanjutkan.
Tanda tangan:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat data harus diunggah. |
data | Gumpalan | Uint8Array | ArrayBuffer | Data yang akan diunggah. |
metadata | Unggah Metadata | Metadata untuk data yang akan diunggah. |
Pengembalian:
Janji< UploadResult >
Janji yang berisi UploadResult
uploadBytesResumable(ref, data, metadata)
Mengunggah data ke lokasi objek ini. Pengunggahan dapat dijeda dan dilanjutkan, serta menampilkan pembaruan kemajuan.
Tanda tangan:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat data harus diunggah. |
data | Gumpalan | Uint8Array | ArrayBuffer | Data yang akan diunggah. |
metadata | Unggah Metadata | Metadata untuk data yang akan diunggah. |
Pengembalian:
Tugas Unggah
uploadString(ref, nilai, format, metadata)
Mengunggah string ke lokasi objek ini. Pengunggahan tidak dapat dilanjutkan.
Tanda tangan:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
referensi | Referensi Penyimpanan | StorageReference tempat string harus diunggah. |
nilai | rangkaian | String yang akan diunggah. |
format | Format String | Format string yang akan diunggah. |
metadata | Unggah Metadata | Metadata untuk string yang akan diunggah. |
Pengembalian:
Janji< UploadResult >
Janji yang berisi UploadResult
fungsi(penyimpananOrRef, ...)
ref(storageOrRef, jalur)
Mengembalikan StorageReference untuk jalur tertentu di bucket default.
Tanda tangan:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
penyimpananAtauRef | Penyimpanan Firebase | Referensi Penyimpanan | FirebaseStorage atau StorageReference . |
jalur | rangkaian |
Pengembalian:
Format String
Pencacahan kemungkinan format string untuk diunggah.
Tanda tangan:
StringFormat: {
readonly RAW: "raw";
readonly BASE64: "base64";
readonly BASE64URL: "base64url";
readonly DATA_URL: "data_url";
}
Format String
Pencacahan kemungkinan format string untuk diunggah.
Tanda tangan:
export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
Acara Tugas
Suatu peristiwa yang dipicu pada suatu tugas.
Tanda tangan:
export declare type TaskEvent = 'state_changed';
Status Tugas
Mewakili status unggahan yang sedang berjalan.
Tanda tangan:
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
Kode Kesalahan Penyimpanan
Kode kesalahan yang dapat dilampirkan ke objek StorageError
.
Tanda tangan:
export declare enum StorageErrorCode
Anggota Pencacahan
Anggota | Nilai | Keterangan |
---|---|---|
APP_DELETED | "app-deleted" | |
BUCKET_NOT_FOUND | "bucket-not-found" | |
DIBATALKAN | "canceled" | |
TIDAK BISA_SLICE_BLOB | "cannot-slice-blob" | |
KESALAHAN INTERNAL | "internal-error" | |
ARGUMEN YANG TIDAK SAH | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
FORMAT YANG TIDAK VALID | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
INVALID_URL | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
TIDAK_DOWNLOAD_URL | "no-download-url" | |
OBJEK TIDAK DITEMUKAN | "object-not-found" | |
PROJECT_NOT_FOUND | "project-not-found" | |
KUOTA TERLAMPAUI | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" | |
TIDAK DIAutentikasi | "unauthenticated" | |
TIDAK SAH | "unauthorized" | |
TIDAK SAH_APP | "unauthorized-app" | |
TIDAK DIKENAL | "unknown" | |
TIDAK DIDUKUNG_ENVIRONMENT | "unsupported-environment" |