AppOptions interface

Opções disponíveis para transmitir para InitializeApp().

Assinatura:

export interface AppOptions 

Propriedades

Propriedade Tipo Descrição
credencial Credential Um objeto Credential usado para autenticar o SDK Admin.Consulte Inicializar o SDK para documentação detalhada e exemplos de código.
databaseAuthVariableOverride objeto | nulo O objeto que será usado como a variável auth nas regras do Realtime Database quando o SDK Admin fizer leituras ou gravações no Realtime Database. Isso permite diminuir o escopo do SDK Admin dos privilégios completos de leitura e gravação padrão.Você pode transmitir null para agir como um cliente não autenticado.Consulte Autenticar com privilégios limitados para documentação detalhada e exemplos de código.
databaseURL (link em inglês) string O URL do Realtime Database em que os dados são lidos e gravados.
httpAgent (em inglês) Agente Um agente HTTP a ser usado ao fazer chamadas HTTP de saída. Essa instância do agente é usada por todos os serviços que fazem chamadas REST (por exemplo, auth, messaging, projectManagement).O Realtime Database e o Firestore usam outros meios de comunicação com os servidores de back-end, por isso não usam esse agente HTTP. As instâncias Credential também não usam esse agente HTTP, mas aceitam a especificação de um agente HTTP nos métodos de fábrica correspondentes.
projectId string O ID do projeto do Google Cloud associado ao app.
serviceAccountId. string O ID da conta de serviço a ser usada para assinar tokens personalizados. Isso pode ser encontrado no campo client_email de um arquivo JSON da conta de serviço.
storageBucket string O nome do bucket do Google Cloud Storage usado para armazenar dados do aplicativo. Use apenas o nome do bucket sem prefixos ou adições. *Não* use "gs://" antes do nome.

AppOptions.credential

Um objeto Credential usado para autenticar o SDK Admin.

Consulte Inicializar o SDK para ver a documentação detalhada e os exemplos de código.

Assinatura:

credential?: Credential;

AppOptions.databaseAuthVariableOverride

O objeto que será usado como a variável auth nas regras do Realtime Database quando o SDK Admin fizer leituras ou gravações no Realtime Database. Isso permite que você reduza o escopo do SDK Admin dos privilégios completos de leitura e gravação padrão.

É possível transmitir null para atuar como um cliente não autenticado.

Consulte Autenticar com privilégios limitados para consultar documentação detalhada e exemplos de código.

Assinatura:

databaseAuthVariableOverride?: object | null;

AppOptions.databaseURL

O URL do Realtime Database em que os dados são lidos e gravados.

Assinatura:

databaseURL?: string;

AppOptions.httpAgent

Um agente HTTP a ser usado ao fazer chamadas HTTP de saída. Esta instância do Agent é usada por todos os serviços que fazem chamadas REST (por exemplo, auth, messaging, projectManagement).

O Realtime Database e o Firestore usam outros meios de comunicação com os servidores de back-end, por isso não usam esse agente HTTP. As instâncias Credential também não usam esse agente HTTP, mas aceitam a especificação de um agente HTTP nos métodos de fábrica correspondentes.

Assinatura:

httpAgent?: Agent;

AppOptions.projectId

O ID do projeto do Google Cloud associado ao app.

Assinatura:

projectId?: string;

AppOptions.serviceAccountId

O ID da conta de serviço a ser usada para assinar tokens personalizados. Isso pode ser encontrado no campo client_email de um arquivo JSON da conta de serviço.

Assinatura:

serviceAccountId?: string;

AppOptions.storageBucket

O nome do bucket do Google Cloud Storage usado para armazenar dados do aplicativo. Use apenas o nome do bucket sem prefixos ou adições. *Não* use "gs://" antes do nome.

Assinatura:

storageBucket?: string;