AppOptions interface

Options disponibles à transmettre à initializeApp() .

Signature:

export interface AppOptions 

Propriétés

Propriété Taper Description
informations d'identification Informations d'identification Un objet Credential utilisé pour authentifier le SDK Admin. Consultez Initialiser le SDK pour obtenir une documentation détaillée et des exemples de code.
base de donnéesAuthVariableOverride objet | nul Objet à utiliser comme variable d'authentification dans vos règles de base de données en temps réel lorsque le SDK Admin lit ou écrit dans la base de données en temps réel. Cela vous permet de réduire la portée du SDK Admin par rapport à ses privilèges complets de lecture et d'écriture par défaut. Vous pouvez transmettre null pour agir en tant que client non authentifié. Voir Authentifier avec des privilèges limités pour une documentation détaillée et des exemples de code.
URL de base de données chaîne L'URL de la base de données en temps réel à partir de laquelle lire et écrire des données.
httpAgent Agent Un agent HTTP à utiliser lors des appels HTTP sortants. Cette instance d'agent est utilisée par tous les services qui effectuent des appels REST (par exemple auth , messaging , projectManagement ). Realtime Database et Firestore utilisent d'autres moyens de communication avec les serveurs backend, ils n'utilisent donc pas cet agent HTTP. Les instances Credential n'utilisent pas non plus cet agent HTTP, mais prennent en charge la spécification d'un agent HTTP dans les méthodes de fabrique correspondantes.
ID du projet chaîne L'ID du projet Google Cloud associé à l'application.
serviceAccountId chaîne L'ID du compte de service à utiliser pour signer des jetons personnalisés. Celui-ci se trouve dans le champ client_email d'un fichier JSON de compte de service.
seau de stockage chaîne Nom du bucket Google Cloud Storage utilisé pour stocker les données d'application. Utilisez uniquement le nom du bucket, sans aucun préfixe ni ajout (ne préfixez *pas* le nom avec "gs://").

AppOptions.credential

Un objet Credential utilisé pour authentifier le SDK Admin.

Consultez Initialiser le SDK pour obtenir une documentation détaillée et des exemples de code.

Signature:

credential?: Credential;

AppOptions.databaseAuthVariableOverride

Objet à utiliser comme variable d'authentification dans vos règles de base de données en temps réel lorsque le SDK Admin lit ou écrit dans la base de données en temps réel. Cela vous permet de réduire la portée du SDK Admin par rapport à ses privilèges complets de lecture et d'écriture par défaut.

Vous pouvez transmettre null pour agir en tant que client non authentifié.

Voir Authentifier avec des privilèges limités pour une documentation détaillée et des exemples de code.

Signature:

databaseAuthVariableOverride?: object | null;

AppOptions.databaseURL

L'URL de la base de données en temps réel à partir de laquelle lire et écrire des données.

Signature:

databaseURL?: string;

AppOptions.httpAgent

Un agent HTTP à utiliser lors des appels HTTP sortants. Cette instance d'agent est utilisée par tous les services qui effectuent des appels REST (par exemple, auth , messaging , projectManagement ).

Realtime Database et Firestore utilisent d'autres moyens de communication avec les serveurs backend, ils n'utilisent donc pas cet agent HTTP. Les instances Credential n'utilisent pas non plus cet agent HTTP, mais prennent en charge la spécification d'un agent HTTP dans les méthodes de fabrique correspondantes.

Signature:

httpAgent?: Agent;

AppOptions.projectId

L'ID du projet Google Cloud associé à l'application.

Signature:

projectId?: string;

AppOptions.serviceAccountId

L'ID du compte de service à utiliser pour signer des jetons personnalisés. Celui-ci se trouve dans le champ client_email d'un fichier JSON de compte de service.

Signature:

serviceAccountId?: string;

AppOptions.storageBucket

Nom du bucket Google Cloud Storage utilisé pour stocker les données d'application. Utilisez uniquement le nom du bucket, sans aucun préfixe ni ajout (ne préfixez *pas* le nom avec "gs://").

Signature:

storageBucket?: string;