storage package

Archiviazione nel cloud per Firebase

Funzioni

Funzione Descrizione
funzione(app, ...)
getStorage(app, bucketUrl) Ottiene un'istanza FirebaseStorage per l'app Firebase specificata.
funzione (archiviazione, ...)
connectStorageEmulator(archiviazione, host, porta, opzioni) Modifica questa istanza FirebaseStorage per comunicare con l'emulatore Cloud Storage.
rif(archiviazione, URL) Restituisce un StorageReference per l'URL specificato.
funzione(rif, ...)
eliminaOggetto(rif) Elimina l'oggetto in questa posizione.
getBlob(rif, maxDownloadSizeBytes) Scarica i dati nella posizione dell'oggetto. Restituisce un errore se l'oggetto non viene trovato. Per utilizzare questa funzionalità, devi autorizzare l'origine della tua app nel bucket Cloud Storage. Vedi anche https://cloud.google.com/storage/docs/configuring-cors Questa API non è disponibile in Node.
getBytes(rif, maxDownloadSizeBytes) Scarica i dati nella posizione dell'oggetto. Restituisce un errore se l'oggetto non viene trovato. Per utilizzare questa funzionalità, devi autorizzare l'origine della tua app nel bucket Cloud Storage. Vedi anche https://cloud.google.com/storage/docs/configuring-cors
getDownloadURL(rif) Restituisce l'URL di download per lo StorageReference specificato .
getMetadata(rif) Una Promise che si risolve con i metadati per questo oggetto. Se questo oggetto non esiste o i metadati non possono essere recuperati, la promessa viene rifiutata.
getStream(rif, maxDownloadSizeBytes) Scarica i dati nella posizione dell'oggetto. Genera un evento di errore se l'oggetto non viene trovato. Questa API è disponibile solo in Node.
elenco(rif, opzioni) Elenca gli elementi (file) e i prefissi (cartelle) sotto questo riferimento di archiviazione. L'API List è disponibile solo per le regole Firebase versione 2. GCS è un negozio di keyblob. Firebase Storage impone la semantica della struttura di cartelle delimitate da "/". Fai riferimento all'API List di GCS se vuoi saperne di più. Per aderire alla semantica delle regole Firebase, Firebase Storage non supporta oggetti i cui percorsi terminano con "/" o contengono due "/" consecutivi. L'API Firebase Storage List filtrerà questi oggetti non supportati. list() potrebbe fallire se nel bucket sono presenti troppi oggetti non supportati.
elencoTutto(rif) Elenca tutti gli elementi (file) e i prefissi (cartelle) sotto questo riferimento di archiviazione. Questo è un metodo di supporto per chiamare list() ripetutamente fino a quando non vengono più visualizzati risultati. La dimensione di impaginazione predefinita è 1000. Nota: i risultati potrebbero non essere coerenti se gli oggetti vengono modificati durante l'esecuzione di questa operazione. Avvertenza: listAll potrebbe potenzialmente consumare troppe risorse se sono presenti troppi risultati.
updateMetadata(rif, metadati) Aggiorna i metadati per questo oggetto.
uploadBytes(rif, dati, metadati) Carica i dati nella posizione di questo oggetto. Il caricamento non è ripristinabile.
uploadBytesResumable(rif, dati, metadati) Carica i dati nella posizione di questo oggetto. Il caricamento può essere messo in pausa e ripreso ed espone gli aggiornamenti sullo stato di avanzamento.
uploadString(rif, valore, formato, metadati) Carica una stringa nella posizione di questo oggetto. Il caricamento non è ripristinabile.
funzione(storageOrRef, ...)
ref(storageOrRef, percorso) Restituisce un StorageReference per il percorso specificato nel bucket predefinito.

Classi

Classe Descrizione
Errore di archiviazione Un errore restituito dall'SDK di Firebase Storage.

Enumerazioni

Enumerazione Descrizione
StorageErrorCode Codici di errore che possono essere allegati agli oggetti StorageError .

Interfacce

Interfaccia Descrizione
FirebaseStorage Un'istanza di Firebase Storage.
FullMetadata Il set completo di metadati dell'oggetto, incluse le proprietà di sola lettura.
Opzioni elenco Le opzioni list() accetta.
Risultato elenco Risultato restituito da list().
Metadati impostabili Metadati dell'oggetto che possono essere impostati in qualsiasi momento.
StorageObserver Un osservatore di flussi per Firebase Storage.
Riferimento di archiviazione Rappresenta un riferimento a un oggetto Google Cloud Storage. Gli sviluppatori possono caricare, scaricare ed eliminare oggetti, nonché ottenere/impostare i metadati degli oggetti.
Carica metadati Metadati dell'oggetto che possono essere impostati al momento del caricamento.
Carica risultato Risultato restituito da un caricamento non ripristinabile.
Carica attività Rappresenta il processo di caricamento di un oggetto. Consente di monitorare e gestire il caricamento.
Carica TaskSnapshot Contiene i dati sullo stato corrente dell'attività di caricamento.

Variabili

Variabile Descrizione
StringFormat Un'enumerazione dei possibili formati di stringa per il caricamento.

Digitare Alias

Digita Alias Descrizione
StringFormat Un'enumerazione dei possibili formati di stringa per il caricamento.
TaskEvent Un evento che viene attivato su un'attività.
TaskState Rappresenta lo stato corrente di un caricamento in esecuzione.

funzione(app, ...)

getStorage(app, bucketUrl)

Ottiene un'istanza FirebaseStorage per l'app Firebase specificata.

Firma:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

Parametri

Parametro Tipo Descrizione
app FirebaseApp App Firebase per cui ottenere l'istanza FirebaseStorage .
bucketUrl corda L'URL gs:// del bucket di archiviazione Firebase. Se non viene superato, utilizza il bucket di archiviazione predefinito dell'app.

Ritorna:

FirebaseStorage

Un'istanza FirebaseStorage .

funzione (archiviazione, ...)

connectStorageEmulator(archiviazione, host, porta, opzioni)

Modifica questa istanza FirebaseStorage per comunicare con l'emulatore Cloud Storage.

Firma:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parametri

Parametro Tipo Descrizione
magazzinaggio FirebaseStorage L'istanza FirebaseStorage
ospite corda L'host dell'emulatore (es: localhost)
porta numero La porta dell'emulatore (es: 5001)
opzioni { mockUserToken?: EmulatorMockTokenOptions | corda; } Opzioni dell'emulatore. options.mockUserToken è il token di autenticazione fittizia da utilizzare per le regole di sicurezza dei test unitari.

Ritorna:

vuoto

rif(archiviazione, URL)

Restituisce un StorageReference per l'URL specificato.

Firma:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

Parametri

Parametro Tipo Descrizione
magazzinaggio FirebaseStorage Istanza FirebaseStorage .
URL corda URL. Se vuoto, restituisce il riferimento root.

Ritorna:

Riferimento di archiviazione

funzione(rif, ...)

eliminaOggetto(rif)

Elimina l'oggetto in questa posizione.

Firma:

export declare function deleteObject(ref: StorageReference): Promise<void>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference per l'oggetto da eliminare.

Ritorna:

Promesso<vuoto>

Una Promise che si risolve se l'eliminazione ha esito positivo.

getBlob(rif, maxDownloadSizeBytes)

Scarica i dati nella posizione dell'oggetto. Restituisce un errore se l'oggetto non viene trovato.

Per utilizzare questa funzionalità, devi autorizzare l'origine della tua app nel bucket Cloud Storage. Vedi anche https://cloud.google.com/storage/docs/configuring-cors

Questa API non è disponibile in Node.

Firma:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference in cui devono essere scaricati i dati.
maxDownloadSizeBytes numero Se impostata, la dimensione massima consentita in byte da recuperare.

Ritorna:

Promesso<Blob>

Oggetto Promise che si risolve con un Blob contenente i byte dell'oggetto

getBytes(rif, maxDownloadSizeBytes)

Scarica i dati nella posizione dell'oggetto. Restituisce un errore se l'oggetto non viene trovato.

Per utilizzare questa funzionalità, devi autorizzare l'origine della tua app nel bucket Cloud Storage. Vedi anche https://cloud.google.com/storage/docs/configuring-cors

Firma:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference in cui devono essere scaricati i dati.
maxDownloadSizeBytes numero Se impostata, la dimensione massima consentita in byte da recuperare.

Ritorna:

Promessa<ArrayBuffer>

Una Promise contenente i byte dell'oggetto

getDownloadURL(rif)

Restituisce l'URL di download per lo StorageReference specificato .

Firma:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference per cui ottenere l'URL di download.

Ritorna:

Promesso<string>

Una Promise che si risolve con l'URL di download per questo oggetto.

getMetadata(rif)

Una Promise che si risolve con i metadati per questo oggetto. Se questo oggetto non esiste o i metadati non possono essere recuperati, la promessa viene rifiutata.

Firma:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference da cui ottenere i metadati.

Ritorna:

Promessa< FullMetadata >

getStream(rif, maxDownloadSizeBytes)

Scarica i dati nella posizione dell'oggetto. Genera un evento di errore se l'oggetto non viene trovato.

Questa API è disponibile solo in Node.

Firma:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference in cui devono essere scaricati i dati.
maxDownloadSizeBytes numero Se impostata, la dimensione massima consentita in byte da recuperare.

Ritorna:

NodeJS.ReadableStream

Un flusso con i dati dell'oggetto come byte

elenco(rif, opzioni)

Elenca gli elementi (file) e i prefissi (cartelle) sotto questo riferimento di archiviazione.

L'API List è disponibile solo per le regole Firebase versione 2.

GCS è un negozio di keyblob. Firebase Storage impone la semantica della struttura di cartelle delimitate da "/". Fai riferimento all'API List di GCS se vuoi saperne di più.

Per aderire alla semantica delle regole Firebase, Firebase Storage non supporta oggetti i cui percorsi terminano con "/" o contengono due "/" consecutivi. L'API Firebase Storage List filtrerà questi oggetti non supportati. list() potrebbe fallire se nel bucket sono presenti troppi oggetti non supportati.

Firma:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference da cui ottenere l'elenco.
opzioni Opzioni elenco Vedi Opzioni elenco per i dettagli.

Ritorna:

Promessa< Risultatoelenco >

Una Promise che si risolve con gli elementi e i prefissi. prefixes contiene riferimenti a sottocartelle e items contiene riferimenti a oggetti in questa cartella. nextPageToken può essere utilizzato per ottenere il resto dei risultati.

elencoTutto(rif)

Elenca tutti gli elementi (file) e i prefissi (cartelle) sotto questo riferimento di archiviazione.

Questo è un metodo di supporto per chiamare list() ripetutamente fino a quando non vengono più visualizzati risultati. La dimensione di impaginazione predefinita è 1000.

Firma:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference da cui ottenere l'elenco.

Ritorna:

Promessa< Risultatoelenco >

Una Promise che si risolve con tutti gli elementi e i prefissi sotto il riferimento di archiviazione corrente. prefixes contiene riferimenti a sottodirectory e items contiene riferimenti a oggetti in questa cartella. nextPageToken non viene mai restituito.

updateMetadata(rif, metadati)

Aggiorna i metadati per questo oggetto.

Firma:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference per cui aggiornare i metadati.
metadati Metadati impostabili I nuovi metadati per l'oggetto. Verranno modificati solo i valori impostati esplicitamente. L'impostazione esplicita di un valore su null rimuoverà i metadati.

Ritorna:

Promessa< FullMetadata >

Una Promise che si risolve con i nuovi metadati per questo oggetto.

uploadBytes(rif, dati, metadati)

Carica i dati nella posizione di questo oggetto. Il caricamento non è ripristinabile.

Firma:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference in cui caricare i dati.
dati Macchia | Uint8Array | ArrayBuffer I dati da caricare.
metadati Carica metadati Metadati per i dati da caricare.

Ritorna:

Promessa< RisultatoCaricamento >

Una promessa contenente un UploadResult

uploadBytesResumable(rif, dati, metadati)

Carica i dati nella posizione di questo oggetto. Il caricamento può essere messo in pausa e ripreso ed espone gli aggiornamenti sullo stato di avanzamento.

Firma:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference in cui caricare i dati.
dati Macchia | Uint8Array | ArrayBuffer I dati da caricare.
metadati Carica metadati Metadati per i dati da caricare.

Ritorna:

Carica attività

Un'attività di caricamento

uploadString(rif, valore, formato, metadati)

Carica una stringa nella posizione di questo oggetto. Il caricamento non è ripristinabile.

Firma:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

Parametri

Parametro Tipo Descrizione
rif Riferimento di archiviazione StorageReference dove la stringa deve essere caricata.
valore corda La stringa da caricare.
formato StringFormat Il formato della stringa da caricare.
metadati Carica metadati Metadati per la stringa da caricare.

Ritorna:

Promessa< RisultatoCaricamento >

Una promessa contenente un UploadResult

funzione(storageOrRef, ...)

ref(storageOrRef, percorso)

Restituisce un StorageReference per il percorso specificato nel bucket predefinito.

Firma:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

Parametri

Parametro Tipo Descrizione
stoccaggioORif FirebaseArchiviazione | Riferimento di archiviazione FirebaseStorage o StorageReference .
sentiero corda

Ritorna:

Riferimento di archiviazione

StringFormat

Un'enumerazione dei possibili formati di stringa per il caricamento.

Firma:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

StringFormat

Un'enumerazione dei possibili formati di stringa per il caricamento.

Firma:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

TaskEvent

Un evento che viene attivato su un'attività.

Firma:

export declare type TaskEvent = 'state_changed';

TaskState

Rappresenta lo stato corrente di un caricamento in esecuzione.

Firma:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

StorageErrorCode

Codici di errore che possono essere allegati agli oggetti StorageError .

Firma:

export declare enum StorageErrorCode

Enumerazione membri

Membro Valore Descrizione
APP_DELETED "app-deleted"
SECCHIO_NON_TROVATO "bucket-not-found"
ANNULLATO "canceled"
NON PUÒ_SLICE_BLOB "cannot-slice-blob"
ERRORE INTERNO "internal-error"
ARGOMENTO_INVALID "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
NON VALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
NON VALID_EVENT_NAME "invalid-event-name"
FORMATO NON VALIDO "invalid-format"
OPERAZIONE_ROOT_INVALIDA "invalid-root-operation"
URL NON VALIDO "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_URL_DOWNLOAD "no-download-url"
OGGETTO_NON_TROVATO "object-not-found"
PROGETTO_NON_TROVATO "project-not-found"
QUOTA SUPERATA "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
NON AUTENTICATO "unauthenticated"
NON AUTORIZZATO "unauthorized"
APP_NON AUTORIZZATA "unauthorized-app"
SCONOSCIUTO "unknown"
AMBIENTE NON SUPPORTATO "unsupported-environment"