Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi utilizza la seguente richiesta:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

Importa

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

API Panoramica

applyActionCode

Applica la verifica code inviata all'utente via email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });

confirmPasswordReset

Completa il processo di reimpostazione della password.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmPasswordReset({
  oobCode: 'oob-code',
  newPassword: 'new-password',
});

confirmVerificationCode

Completa il processo di verifica del numero di telefono.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.confirmVerificationCode({
  verificationId: 'phoneCodeSent',
  verificationCode: 'phoneCodeSent',
});
// The result holds sensitive values: use it without logging it.

createUserWithEmailAndPassword

Crea un nuovo account utente con email e password. Se l'account nuovo è stato creato, l'utente viene autenticato automaticamente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.createUserWithEmailAndPassword({
  email: 'user@example.com',
  password: 'password',
});
// The result holds sensitive values: use it without logging it.

deleteUser

Cancella e disconnette l'utente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

Esegue la ricerca dei metodi di accesso per un indirizzo email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);

getCurrentUser

Estrae l'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getCurrentUser();
// The result holds sensitive values: use it without logging it.

getPendingAuthResult

Restituisce SignInResult Se il tuo app ha avviato un flusso di segno di accesso web e l'System cleans up l'app mentre è in background.

Solo disponibile per Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getPendingAuthResult();
// The result holds sensitive values: use it without logging it.

getIdToken

Estrae il token di autenticazione Firebase per l'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getIdToken();
// The result holds sensitive values: use it without logging it.

getIdTokenResult

Restituisce un token JSON Web (JWT) deserializzato utilizzato per identificare l'utente a un servizio Firebase.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getIdTokenResult();
// The result holds sensitive values: use it without logging it.

getRedirectResult

Restituisce il SignInResult dal flusso di accesso basato sulla reindirizzamento.

Se l'accesso non è stato riuscito, fallisce con un errore. Se non è stato chiamato alcun operazione di reindirizzamento, restituisce un SignInResult con un utente nullo.

Disponibile solo per Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getRedirectResult();
// The result holds sensitive values: use it without logging it.

getTenantId

Ottieni l'ID tenant.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.getTenantId();
console.log(result);

isSignInWithEmailLink

Controlla se un link in arrivo è un link di accesso con email adatto per signInWithEmailLink.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.isSignInWithEmailLink({ emailLink: 'https://example.com' });
// The result holds sensitive values: use it without logging it.

linkWithApple

Collega l'account utente con il provider di autenticazione Apple.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithApple();
// The result holds sensitive values: use it without logging it.

linkWithEmailAndPassword

Collega l'account utente con il provider di autenticazione Email.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithEmailAndPassword({
  email: 'user@example.com',
  password: 'password',
});
// The result holds sensitive values: use it without logging it.

linkWithEmailLink

Collega l'account utente con il provider di autenticazione Email.

L'utente deve essere connesso al layer nativo. La skipNativeAuth opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithEmailLink({
  email: 'user@example.com',
  emailLink: 'https://example.com',
});
// The result holds sensitive values: use it without logging it.

linkWithFacebook

Collega l'account utente con il provider di autenticazione Facebook.

L'utente deve essere connesso al layer nativo. La skipNativeAuth opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithFacebook();
// The result holds sensitive values: use it without logging it.

linkWithGameCenter

Collega l'account utente con il provider di autenticazione di Game Center.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

Disponibile solo per iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithGameCenter();
// The result holds sensitive values: use it without logging it.

linkWithGithub

Collega l'account utente con il provider di autenticazione di GitHub.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithGithub();
// The result holds sensitive values: use it without logging it.

linkWithGoogle

Collega l'account utente con il provider di autenticazione di Google.

L'utente deve essere connesso al layer nativo. La skipNativeAuth L'opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithGoogle();
// The result holds sensitive values: use it without logging it.

linkWithMicrosoft

Collega l'account utente con il provider di autenticazione Microsoft.

L'utente deve essere connesso al layer nativo. La skipNativeAuth L'opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithMicrosoft();
// The result holds sensitive values: use it without logging it.

linkWithOpenIdConnect

Collega l'account utente con un provider OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithOpenIdConnect({ providerId: 'provider-id-123' });
// The result holds sensitive values: use it without logging it.

linkWithPhoneNumber

Collega l'account utente con il provider di autenticazione del Numero di Telefono.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

Utilizza il phoneVerificationCompleted per essere notificato quando la verifica è completata. phoneVerificationFailed ascoltatore per essere notificato quando la verifica fallisce. Usa il phoneCodeSent per ottenere l'ID di verifica.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPhoneNumber({ phoneNumber: "+16505550101" });

linkWithPlayGames

Collega l'account utente con il provider di autenticazione di Play Games.

L'utente deve essere connesso al layer nativo. skipNativeAuth L'opzione di configurazione non ha effetto qui.

Disponibile solo per Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithPlayGames();
// The result holds sensitive values: use it without logging it.

linkWithTwitter

Collega l'account utente al provider di autenticazione Twitter.

L'utente deve essere connesso al layer nativo. Il skipNativeAuth opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithTwitter();
// The result holds sensitive values: use it without logging it.

linkWithYahoo

Collega l'account utente al provider di autenticazione Yahoo.

L'utente deve essere connesso al layer nativo. Il skipNativeAuth opzione di configurazione non ha effetto qui.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.linkWithYahoo();
// The result holds sensitive values: use it without logging it.

reload

Ricarica i dati dell'account utente, se si è autenticati.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.reload();

revokeAccessToken

Revoca il token di accesso specificato. Attualmente supporta solo i token di accesso OAuth Apple.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.revokeAccessToken({ token: 'token-123' });

sendEmailVerification

Invia un'email di verifica all'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

Invia un'email di reset della password.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendPasswordResetEmail({ email: 'user@example.com' });

sendSignInLinkToEmail

Invia un link di accesso all'indirizzo email specificato dell'utente.

Per completare l'accesso con il link di email, chiama signInWithEmailLink con l'indirizzo email e il link email forniti nell'email inviata all'utente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendSignInLinkToEmail({
  email: 'user@example.com',
  actionCodeSettings: { url: 'https://example.com' },
});

setLanguageCode

Imposta il linguaggio dell'utente code per le operazioni di autenticazione.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setLanguageCode({ languageCode: "en-US" });

setPersistence

Imposta il tipo di persistenza per la sessione di autenticazione attualmente salvata.

Disponibile solo per Web.

import { FirebaseAuthentication, Persistence } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setPersistence({ persistence: Persistence.IndexedDbLocal });

setTenantId

Imposta l'ID tenant.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setTenantId({ tenantId: 'tenant-id-123' });

signInAnonymously

Si collega come utente anonimo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInAnonymously();
// The result holds sensitive values: use it without logging it.

signInWithApple

Avvia il flusso di accesso Apple.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithApple();
// The result holds sensitive values: use it without logging it.

signInWithCustomToken

Avvia il flusso di accesso con token personalizzato.

Questo metodo non può essere utilizzato in combinazione con skipNativeAuth su Android e iOS. In questo caso dovrai utilizzare l' signInWithCustomToken interfaccia del Firebase JS SDK direttamente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithCustomToken({ token: 'token-123' });
// The result holds sensitive values: use it without logging it.

signInWithEmailAndPassword

Inizia il flusso di accesso utilizzando un indirizzo e-mail e una password.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithEmailAndPassword({
  email: 'user@example.com',
  password: 'password',
});
// The result holds sensitive values: use it without logging it.

signInWithEmailLink

Accedi utilizzando un indirizzo e-mail e un link di accesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithEmailLink({
  email: 'user@example.com',
  emailLink: 'https://example.com',
});
// The result holds sensitive values: use it without logging it.

signInWithFacebook

Inizia il flusso di accesso con Facebook.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithFacebook();
// The result holds sensitive values: use it without logging it.

signInWithGameCenter

Inizia il flusso di accesso a Game Center.

Disponibile solo per iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithGameCenter();
// The result holds sensitive values: use it without logging it.

signInWithGithub

Starts the GitHub sign-in flow.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithGithub();
// The result holds sensitive values: use it without logging it.

signInWithGoogle

Inizia il flusso di accesso a Google.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithGoogle();
// The result holds sensitive values: use it without logging it.

signInWithMicrosoft

Inizia il flusso di accesso a Microsoft.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithMicrosoft();
// The result holds sensitive values: use it without logging it.

signInWithOpenIdConnect

Inizia il flusso di accesso OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithOpenIdConnect({ providerId: 'provider-id-123' });
// The result holds sensitive values: use it without logging it.

signInWithPhoneNumber

Inizia il flusso di accesso utilizzando un numero di telefono.

Utilizza il phoneVerificationCompleted listener per essere informato quando la verifica è completata. Utilizza il phoneVerificationFailed listener per essere informato quando la verifica fallisce. Utilizza il phoneCodeSent listener per ottenere l'ID di verifica.

Solo disponibile per Android e iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPhoneNumber({ phoneNumber: "+16505550101" });

signInWithPlayGames

Inizia il flusso di accesso con Play Games.

Disponibile solo per Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithPlayGames();
// The result holds sensitive values: use it without logging it.

signInWithTwitter

Inizia il flusso di accesso con Twitter.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithTwitter();
// The result holds sensitive values: use it without logging it.

signInWithYahoo

Inizia il flusso di accesso con Yahoo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.signInWithYahoo();
// The result holds sensitive values: use it without logging it.

signOut

Inizia il flusso di disconnessione.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signOut();

unlink

Disconnette un provider da un account utente.

import { FirebaseAuthentication, ProviderId } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.unlink({ providerId: ProviderId.APPLE });
// The result holds sensitive values: use it without logging it.

updateEmail

Aggiorna l'indirizzo email dell'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateEmail({ newEmail: 'user@example.com' });

updatePassword

Aggiorna la password dell'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updatePassword({ newPassword: 'new-password' });

updateProfile

Aggiorna i dati del profilo dell'utente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateProfile({
  displayName: 'display',
  photoUrl: 'https://example.com',
});

useAppLanguage

Imposta la lingua dell'app code come lingua predefinita dell'app.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useAppLanguage();

useEmulator

Configura l'app per comunicare con l'emulatore di autenticazione.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useEmulator({ host: "127.0.0.1" });

verifyBeforeUpdateEmail

Verifica l'indirizzo email nuovo prima di aggiornare l'indirizzo email dell'utente attualmente connesso.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.verifyBeforeUpdateEmail({ newEmail: 'user@example.com' });

checkAppTrackingTransparencyPermission

Controlla lo stato corrente della richiesta di trasparenza dell'app.

Disponibile solo su iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.checkAppTrackingTransparencyPermission();
console.log(result);

requestAppTrackingTransparencyPermission

Apre il dialogo del sistema per autorizzare la tracciabilità dell'app

Attenzione: L'utente potrebbe aver disabilitato la richiesta di tracciamento nei impostazioni del dispositivo, vedi La documentazione di Apple.

Disponibile solo su iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.requestAppTrackingTransparencyPermission();
console.log(result);

Riferimento di tipo

ApplyActionCodeOptions

export interface ApplyActionCodeOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
}

ConfirmPasswordResetOptions

export interface ConfirmPasswordResetOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
  /**
   * The new password.
   *
   * @since 0.2.2
   */
  newPassword: string;
}

ConfirmVerificationCodeOptions

export interface ConfirmVerificationCodeOptions {
  /**
   * The verification ID received from the `phoneCodeSent` listener.
   *
   * The `verificationCode` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationId: string;
  /**
   * The verification code either received from the `phoneCodeSent` listener or entered by the user.
   *
   * The `verificationId` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationCode: string;
}

SignInResult

export interface SignInResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
  /**
   * Credentials returned by an auth provider.
   *
   * @since 0.1.0
   */
  credential: AuthCredential | null;
  /**
   * Additional user information from a federated identity provider.
   *
   * @since 0.5.1
   */
  additionalUserInfo: AdditionalUserInfo | null;
}

CreateUserWithEmailAndPasswordOptions

export interface CreateUserWithEmailAndPasswordOptions {
  /**
   * @since 0.2.2
   */
  email: string;
  /**
   * @since 0.2.2
   */
  password: string;
}

FetchSignInMethodsForEmailOptions

export interface FetchSignInMethodsForEmailOptions {
  /**
   * The user's email address.
   *
   * @since 6.0.0
   */
  email: string;
}

FetchSignInMethodsForEmailResult

export interface FetchSignInMethodsForEmailResult {
  /**
   * The sign-in methods for the specified email address.
   *
   * This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)
   * is enabled, irrespective of the number of authentication methods available for the given email.
   *
   * @since 6.0.0
   */
  signInMethods: string[];
}

GetCurrentUserResult

export interface GetCurrentUserResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
}

GetIdTokenOptions

export interface GetIdTokenOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 0.1.0
   */
  forceRefresh: boolean;
}

GetIdTokenResult

export interface GetIdTokenResult {
  /**
   * The Firebase Auth ID token JWT string.
   *
   * @since 0.1.0
   */
  token: string;
}

GetIdTokenResultOptions

export interface GetIdTokenResultOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 7.4.0
   */
  forceRefresh: boolean;
}

GetIdTokenResultResult

export interface GetIdTokenResultResult {
  /**
   * The authentication time in milliseconds since the epoch.
   *
   * This is the time the user authenticated (signed in) and not the time the token was refreshed.
   *
   * @since 7.4.0
   */
  authTime: number;
  /**
   * The ID token expiration time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  expirationTime: number;
  /**
   * The ID token issuance time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  issuedAtTime: number;
  /**
   * The sign-in provider through which the ID token was obtained.
   *
   * @since 7.4.0
   */
  signInProvider: string | null;
  /**
   * The type of second factor associated with this session, provided the user was multi-factor
   * authenticated (eg. phone, etc).
   *
   * @since 7.4.0
   */
  signInSecondFactor: string | null;
  /**
   * The entire payload claims of the ID token including the standard reserved claims as well as
   * the custom claims.
   *
   * @since 7.4.0
   */
  claims: Record<string, unknown>;
}

Fonte di verità

Questa pagina è generata dal plugin’s src/definitions.tsRieccere la sincronizzazione quando il pubblico API cambia in alto flusso.

Continua da qui: Iniziare

Se stai utilizzando Getting Started per pianificare l'autenticazione e le flussi di account, connettilo con @capgo/capacitor-login-social per i dettagli di implementazione in @capgo/capacitor-login-social @capgo/capacitor-chiave di accesso per i dettagli di implementazione in @capgo/capacitor-passkey @capgo/capacitor-autenticazione-biometrica-nativa per i dettagli di implementazione in @capgo/capacitor-native-biometric, Autenticazione a due fattori per i dettagli di implementazione in Autenticazione a due fattori, e SSO (Enterprise) per i dettagli di implementazione in SSO (Enterprise).