Armazenamento em nuvem para Firebase
Funções
Função | Descrição |
---|---|
função(aplicativo...) | |
getStorage(aplicativo, bucketUrl) | Obtém uma instância FirebaseStorage para o aplicativo Firebase fornecido. |
função(armazenamento...) | |
connectStorageEmulator(armazenamento, host, porta, opções) | Modifique esta instância do FirebaseStorage para se comunicar com o emulador do Cloud Storage. |
ref(armazenamento, url) | Retorna um StorageReference para o URL fornecido. |
função(ref...) | |
deleteObject(ref) | Exclui o objeto neste local. |
getBlob(ref, maxDownloadSizeBytes) | Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado. Para usar essa funcionalidade, você precisa colocar na lista de permissões a origem do seu aplicativo no seu bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configuring-cors Esta API não está disponível no Node. |
getBytes(ref, maxDownloadSizeBytes) | Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado. Para usar essa funcionalidade, você precisa colocar na lista de permissões a origem do seu aplicativo no seu bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configuring-cors |
getDownloadURL(ref) | Retorna o URL de download para o StorageReference fornecido . |
getMetadata(ref) | Um Promise que resolve com os metadados para este objeto. Se este objeto não existir ou os metadados não puderem ser recuperados, a promessa será rejeitada. |
getStream(ref, maxDownloadSizeBytes) | Baixa os dados no local do objeto. Gera um evento de erro se o objeto não for encontrado. Esta API está disponível apenas em Node. |
lista(ref, opções) | Liste itens (arquivos) e prefixos (pastas) nesta referência de armazenamento. A API de lista só está disponível para Firebase Rules versão 2. O GCS é um armazenamento de blob de chaves. O Firebase Storage impõe a semântica da estrutura de pastas delimitada por '/'. Consulte a API de lista do GCS se quiser saber mais. Para aderir à semântica das regras do Firebase, o Firebase Storage não oferece suporte a objetos cujos caminhos terminam com "/" ou contêm dois "/"s consecutivos. A API Firebase Storage List filtrará esses objetos incompatíveis. list() pode falhar se houver muitos objetos sem suporte no depósito. |
listAll(ref) | Liste todos os itens (arquivos) e prefixos (pastas) nesta referência de armazenamento. Este é um método auxiliar para chamar list() repetidamente até que não haja mais resultados. O tamanho de paginação padrão é 1000. Observação: os resultados podem não ser consistentes se os objetos forem alterados durante a execução desta operação. Aviso: listAll pode consumir muitos recursos se houver muitos resultados. |
updateMetadata(ref, metadados) | Atualiza os metadados para este objeto. |
uploadBytes(ref, dados, metadados) | Carrega dados para a localização deste objeto. O upload não pode ser retomado. |
uploadBytesResumable(ref, dados, metadados) | Carrega dados para a localização deste objeto. O upload pode ser pausado e retomado e expõe atualizações de progresso. |
uploadString(ref, valor, formato, metadados) | Carrega uma string para a localização deste objeto. O upload não pode ser retomado. |
function(armazenamentoOrRef...) | |
ref(armazenamentoOrRef, caminho) | Retorna um StorageReference para o caminho fornecido no bucket padrão. |
Aulas
Aula | Descrição |
---|---|
StorageError | Um erro retornado pelo Firebase Storage SDK. |
Enumerações
Enumeração | Descrição |
---|---|
StorageErrorCode | Códigos de erro que podem ser anexados a objetos StorageError . |
Interfaces
Interface | Descrição |
---|---|
Firebase Storage | Uma instância do Firebase Storage. |
FullMetadata | O conjunto completo de metadados do objeto, incluindo propriedades somente leitura. |
ListaOpções | A list() aceita. |
ListResult | Resultado retornado por list(). |
SettableMetadata | Metadados de objeto que podem ser definidos a qualquer momento. |
StorageObserver | Um observador de fluxo para Firebase Storage. |
Referência de Armazenamento | Representa uma referência a um objeto do Google Cloud Storage. Os desenvolvedores podem carregar, baixar e excluir objetos, bem como obter/definir metadados de objetos. |
UploadMetadados | Metadados de objeto que podem ser definidos no upload. |
UploadResult | Resultado retornado de um upload não retomável. |
UploadTask | Representa o processo de upload de um objeto. Permite monitorar e gerenciar o upload. |
UploadTaskSnapshot | Contém dados sobre o estado atual da tarefa de upload. |
Variáveis
Variável | Descrição |
---|---|
StringFormat | Uma enumeração dos possíveis formatos de string para upload. |
Aliases de tipo
Digite Alias | Descrição |
---|---|
StringFormat | Uma enumeração dos possíveis formatos de string para upload. |
TaskEvent | Um evento que é acionado em uma tarefa. |
TaskState | Representa o estado atual de um upload em execução. |
getStorage()
Obtém uma instância FirebaseStorage para o aplicativo Firebase fornecido.
Assinatura:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
aplicativo | FirebaseApp | Aplicativo Firebase para o qual obter a instância FirebaseStorage . |
URL do balde | corda | O url gs:// do seu Firebase Storage Bucket. Se não aprovado, usa o depósito de armazenamento padrão do aplicativo. |
Retorna:
Uma instância FirebaseStorage .
conectarStorageEmulator()
Modifique esta instância do FirebaseStorage para se comunicar com o emulador do Cloud Storage.
Assinatura:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
armazenar | Firebase Storage | A instância FirebaseStorage |
hospedar | corda | O host do emulador (ex: localhost) |
porta | número | A porta do emulador (ex: 5001) |
opções | { mockUserToken?: EmulatorMockTokenOptions | corda; } | Opções do emulador. options.mockUserToken é o token de autenticação fictício a ser usado para testar as regras de segurança da unidade. |
Retorna:
vazio
ref()
Retorna um StorageReference para o URL fornecido.
Assinatura:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
armazenar | Firebase Storage | instância FirebaseStorage . |
url | corda | URL. Se vazio, retorna a referência raiz. |
Retorna:
deleteObject()
Exclui o objeto neste local.
Assinatura:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para o objeto a ser excluído. |
Retorna:
Promessa<void>
Um Promise
que resolve se a exclusão for bem-sucedida.
getBlob()
Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado.
Para usar essa funcionalidade, você precisa colocar na lista de permissões a origem do seu aplicativo no seu bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configuring-cors
Esta API não está disponível no Node.
Assinatura:
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde os dados devem ser baixados. |
maxDownloadSizeBytes | número | Se definido, o tamanho máximo permitido em bytes para recuperar. |
Retorna:
Promessa<Blob>
Uma promessa que resolve com um Blob contendo os bytes do objeto
getBytes()
Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado.
Para usar essa funcionalidade, você precisa colocar na lista de permissões a origem do seu aplicativo no seu bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configuring-cors
Assinatura:
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde os dados devem ser baixados. |
maxDownloadSizeBytes | número | Se definido, o tamanho máximo permitido em bytes para recuperar. |
Retorna:
Promise<ArrayBuffer>
Uma promessa contendo os bytes do objeto
getDownloadURL()
Retorna o URL de download para o StorageReference fornecido .
Assinatura:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para obter o URL de download. |
Retorna:
Promessa<string>
Um Promise
que resolve com o URL de download para este objeto.
getMetadata()
Um Promise
que resolve com os metadados para este objeto. Se este objeto não existir ou os metadados não puderem ser recuperados, a promessa será rejeitada.
Assinatura:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para obter metadados. |
Retorna:
Promise< FullMetadata >
getStream()
Baixa os dados no local do objeto. Gera um evento de erro se o objeto não for encontrado.
Esta API está disponível apenas em Node.
Assinatura:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde os dados devem ser baixados. |
maxDownloadSizeBytes | número | Se definido, o tamanho máximo permitido em bytes para recuperar. |
Retorna:
NodeJS.ReadableStream
Um fluxo com os dados do objeto como bytes
lista()
Liste itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.
A API de lista só está disponível para Firebase Rules versão 2.
O GCS é um armazenamento de blob de chaves. O Firebase Storage impõe a semântica da estrutura de pastas delimitada por '/'. Consulte a API de lista do GCS se quiser saber mais.
Para aderir à semântica das regras do Firebase, o Firebase Storage não oferece suporte a objetos cujos caminhos terminam com "/" ou contêm dois "/"s consecutivos. A API Firebase Storage List filtrará esses objetos incompatíveis. list() pode falhar se houver muitos objetos sem suporte no bucket.
Assinatura:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para obter a lista. |
opções | ListaOpções | Consulte ListOptions para obter detalhes. |
Retorna:
Promise< ListResult >
Uma Promise
que resolve com os itens e prefixos. prefixes
contém referências a subpastas e items
contém referências a objetos nesta pasta. nextPageToken
pode ser usado para obter o restante dos resultados.
listaTodos()
Liste todos os itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.
Este é um método auxiliar para chamar list() repetidamente até que não haja mais resultados. O tamanho de paginação padrão é 1000.
Assinatura:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para obter a lista. |
Retorna:
Promise< ListResult >
Uma Promise
que resolve com todos os itens e prefixos sob a referência de armazenamento atual. prefixes
contém referências a subdiretórios e items
contém referências a objetos nesta pasta. nextPageToken
nunca é retornado.
updateMetadata()
Atualiza os metadados para este objeto.
Assinatura:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference para atualizar os metadados. |
metadados | SettableMetadata | Os novos metadados para o objeto. Apenas os valores que foram definidos explicitamente serão alterados. Definir explicitamente um valor como nulo removerá os metadados. |
Retorna:
Promise< FullMetadata >
Um Promise
que resolve com os novos metadados para este objeto.
uploadBytes()
Carrega dados para a localização deste objeto. O upload não pode ser retomado.
Assinatura:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde os dados devem ser carregados. |
dados | bolha | Uint8Array | ArrayBuffer | Os dados a serem carregados. |
metadados | UploadMetadados | Metadados para os dados a serem carregados. |
Retorna:
Promise< UploadResult >
Uma Promise contendo um UploadResult
uploadBytesResumable()
Carrega dados para a localização deste objeto. O upload pode ser pausado e retomado e expõe atualizações de progresso.
Assinatura:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde os dados devem ser carregados. |
dados | bolha | Uint8Array | ArrayBuffer | Os dados a serem carregados. |
metadados | UploadMetadados | Metadados para os dados a serem carregados. |
Retorna:
Uma tarefa de upload
uploadString()
Carrega uma string para a localização deste objeto. O upload não pode ser retomado.
Assinatura:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ref | Referência de Armazenamento | StorageReference onde a string deve ser carregada. |
valor | corda | A string a ser carregada. |
formatar | StringFormat | O formato da string a ser carregada. |
metadados | UploadMetadados | Metadados para a string a ser carregada. |
Retorna:
Promise< UploadResult >
Uma Promise contendo um UploadResult
ref()
Retorna um StorageReference para o caminho fornecido no bucket padrão.
Assinatura:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
storageOrRef | FirebaseStorage | Referência de Armazenamento | FirebaseStorage ou StorageReference . |
caminho | corda |
Retorna:
StringFormat
Uma enumeração dos possíveis formatos de string para upload.
Assinatura:
StringFormat: {
readonly RAW: "raw";
readonly BASE64: "base64";
readonly BASE64URL: "base64url";
readonly DATA_URL: "data_url";
}
StringFormat
Uma enumeração dos possíveis formatos de string para upload.
Assinatura:
export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
TaskEvent
Um evento que é acionado em uma tarefa.
Assinatura:
export declare type TaskEvent = 'state_changed';
TaskState
Representa o estado atual de um upload em execução.
Assinatura:
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
StorageErrorCode
Códigos de erro que podem ser anexados a objetos StorageError
.
Assinatura:
export declare enum StorageErrorCode
Membros de Enumeração
Membro | Valor | Descrição |
---|---|---|
APP_DELETED | "app-deleted" | |
BUCKET_NOT_FOUND | "bucket-not-found" | |
CANCELADO | "canceled" | |
CANNOT_SLICE_BLOB | "cannot-slice-blob" | |
ERRO INTERNO | "internal-error" | |
ARGUMENTO INVÁLIDO | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
FORMATO INVÁLIDO | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
URL INVÁLIDA | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_DOWNLOAD_URL | "no-download-url" | |
OBJETO NÃO ENCONTRADO | "object-not-found" | |
PROJECT_NOT_FOUND | "project-not-found" | |
COTA EXCEDIDA | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" | |
NÃO AUTENTICADO | "unauthenticated" | |
NÃO AUTORIZADO | "unauthorized" | |
UNAUTHORIZED_APP | "unauthorized-app" | |
DESCONHECIDO | "unknown" | |
AMBIENTE_NÃO SUPORTADO | "unsupported-environment" |