Inizia con Getting Started

Installazione

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

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

Usa poi il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo platform sotto:

npm install @capgo/capacitor-webview-crash
npx cap sync

Importa

import { WebViewCrash } from '@capgo/capacitor-webview-crash';

Flusso di recupero consigliato

Aggiungi ascoltatori il prima possibile durante l'avvio dell'applicazione, in modo che il runtime recuperato possa reagire prima che gli utenti continuino a navigare:

import { WebViewCrash } from '@capgo/capacitor-webview-crash';

await WebViewCrash.addListener('webViewRestoredAfterCrash', async (info) => {
  console.log('Recovered after a WebView crash', info);

  // Rehydrate critical state, reopen the correct screen, or prompt the user to retry.
  await WebViewCrash.clearPendingCrashInfo();
});

await WebViewCrash.addListener('webViewRestoredAfterRestart', async (info) => {
  console.log('Recovered after a native WebView restart', info);
  await WebViewCrash.clearPendingCrashInfo();
});

const pending = await WebViewCrash.getPendingCrashInfo();
// Note: the listener callback may have already cleared the pending marker.
if (pending.value) {
  console.log('Pending crash or restart marker', pending.value);
}

Ripristino auto nativo

Imposta le opzioni di ripristino in capacitor.config.ts in modo che la decisione rimanga in code nativo anche quando il runtime JavaScript si è bloccato o non è stato caricato:

import type { CapacitorConfig } from '@capacitor/cli';
import type { WebViewCrashPluginConfig } from '@capgo/capacitor-webview-crash';

const webViewCrash: WebViewCrashPluginConfig = {
  // Enabled by default. Keep this on for long-running apps.
  restartOnCrash: true,

  // Use a 5-field cron schedule in the device local timezone.
  // Do not combine restartCron with an active restartIntervalMs.
  restartCron: '0 3 * * *',

  // Optional delay before restarting after a crash.
  restartAfterCrashDelayMs: 0,
};

const config: CapacitorConfig = {
  plugins: {
    WebViewCrash: webViewCrash,
  },
};

export default config;

Usa restartIntervalMs For applicazioni sempre attive in cui gli utenti possono tenere lo stesso WebView aperto per giorni: schermate di kiosk, dashboard di controllo, scanner di magazzino, terminali POS, tablet di flotta e segnali digitali. Utilizza restartCron Per riavvii orari come 0 3 * * * Per un riavvio quotidiano alle 03:00 nella zona oraria locale del dispositivo. I riavvi programmati scrivono un marker di attesa con reason: 'periodicRestart', quindi Android ricrea l'attività host e iOS ricostruisce la vista del ponte Capacitor in modo da creare un nuovo WKWebView Si crea da native code.

Scegliere un intervallo o un orario cron che il tuo prodotto può tollerare. restartCron Sostiene *, liste, intervalli e passaggi. Non configurare entrambi gli orari contemporaneamente: l'inizializzazione nativa lancia un errore di configurazione fatale quando restartCron è impostato e restartIntervalMs è maggiore di 0. Un riavvio crea un runtime JavaScript fresco, quindi persisti gli eventi in coda, lo stato non salvato dei form e lo stato di navigazione corrente prima di utilizzare gli orari aggressivi.

Riavvio nativo manuale

Chiama restartWebView() quando il runtime JavaScript corrente decide che il WebView nativo debba essere sostituito proattivamente, ad esempio dopo un flusso di lavoro pesante in termini di memoria o prima di entrare in una lunga sessione non assistita:

await WebViewCrash.restartWebView();

La metodologia scrive un marker pendente con reason: 'manualRestart'risolve la chiamata corrente, poi chiede al nativo code di creare un WebView fresco. L'Android ricrea l'attività host. L'iOS ricostruisce il ponte di visualizzazione Capacitor in modo che venga creato un nuovo WKWebView piuttosto che ricaricare la pagina corrente.

Panoramica di API

getPendingCrashInfo

Restituisce il marker di crash o riavvio nativo memorizzato, o null quando non c'è nulla in sospeso.

const pending = await WebViewCrash.getPendingCrashInfo();
if (pending.value) {
  console.log(pending.value.platform, pending.value.reason);
}

clearPendingCrashInfo

Elimina il marker memorizzato dopo che il tuo trattamento di recupero è completato.

await WebViewCrash.clearPendingCrashInfo();

simulateCrashRecovery

Crea un marker di crash fittizio in modo che i QA e il debug locale possano esercitare la via di recupero senza far crashare un WebView reale.

const simulated = await WebViewCrash.simulateCrashRecovery();
console.log(simulated.value);

restartWebView

Memorizza un marker di riavvio manuale e chiede al nativo code di creare un WebView fresco.

await WebViewCrash.restartWebView();

Note sulla piattaforma

• Android archivia i metadati degli errori di crash da onRenderProcessGone, inclusi didCrash e quando la piattaforma li fornisce. rendererPriorityAtExit IOS archivia i metadati degli errori di crash da
• e aggiunge lo stato dell'applicazione corrente quando disponibile. webViewWebContentProcessDidTerminate I restart manuali e programmati creano una nuova vista WebView. Android ricrea l'attività host; iOS ricostruisce il ponte di visualizzazione __CAPGO_KEEP_0__.
• Manual and scheduled restarts create a fresh WebView. Android recreates the host activity; iOS rebuilds the Capacitor bridge view.
• ; i restart manuali utilizzano reason: 'periodicRestart'La web non rileva i crash del renderer reale. L'implementazione web simula solo il comportamento con il locale storage. reason: 'manualRestart'.
• Riferimento di tipo

Sottosezione intitolata “Riferimento di tipo”

PendingCrashInfoResult

export interface PendingCrashInfoResult {
  /**
   * Stored crash or restart metadata, or `null` when no marker is pending.
   */
  value: WebViewCrashInfo | null;
}

WebViewCrashPluginConfig

export interface WebViewCrashPluginConfig {
  /**
   * Restart the WebView from native code when the renderer process dies.
   *
   * @default true
   */
  restartOnCrash?: boolean;

  /**
   * Fixed native interval, in milliseconds, for proactively replacing long-running WebViews.
   *
   * Set to `0` to disable interval restarts. Do not combine an active interval
   * with `restartCron`; native initialization fails fast when both schedules are configured.
   *
   * @default 0
   */
  restartIntervalMs?: number;

  /**
   * Cron schedule for proactively replacing long-running WebViews.
   *
   * Uses standard 5-field cron syntax in the device local timezone:
   * `minute hour day-of-month month day-of-week`.
   *
   * Examples:
   * - `0 3 * * *` restarts every day at 03:00.
   * - `0,30 * * * *` restarts every 30 minutes.
   *
   * Do not combine this with an active `restartIntervalMs`; native initialization
   * fails fast when both schedules are configured.
   */
  restartCron?: string;

  /**
   * Delay, in milliseconds, before restarting after a crash.
   *
   * @default 0
   */
  restartAfterCrashDelayMs?: number;
}

WebViewCrashInfo

export interface WebViewCrashInfo {
  /**
   * Platform that detected and stored the marker.
   */
  platform: WebViewCrashPlatform;

  /**
   * Unix timestamp in milliseconds for when the marker was written.
   */
  timestamp: number;

  /**
   * ISO-8601 version of `timestamp`.
   */
  timestampISO: string;

  /**
   * Platform-specific reason for the crash or restart marker.
   */
  reason: WebViewCrashReason;

  /**
   * Last known WebView URL when the marker was written.
   */
  url?: string;

  /**
   * Android-only hint from `RenderProcessGoneDetail.didCrash()`.
   */
  didCrash?: boolean;

  /**
   * Android-only renderer priority reported at exit.
   */
  rendererPriorityAtExit?: number;

  /**
   * iOS-only application state captured when the WebView process died.
   */
  appState?: WebViewCrashAppState;
}

WebViewCrashPlatform

export type WebViewCrashPlatform = 'android' | 'ios' | 'web';

WebViewCrashReason

export type WebViewCrashReason =
  | 'renderProcessGone'
  | 'webContentProcessDidTerminate'
  | 'periodicRestart'
  | 'manualRestart'
  | 'simulated';

WebViewCrashAppState

export type WebViewCrashAppState = 'active' | 'inactive' | 'background' | 'unknown';

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da Iniziare

Se stai utilizzando Iniziare per pianificare il comportamento di media e interfaccia nativa, connettilo con Utilizzando @capgo/capacitor-webview-crash per la capacità nativa in Utilizzando @capgo/capacitor-webview-crash, Utilizzando @capgo/capacitor-live-activities per la capacità nativa in Utilizzare @capgo/capacitor-live-attività, @capgo/capacitor-live-attività, per il dettaglio di implementazione in @capgo/capacitor-live-attività, Utilizzare @capgo/capacitor-video-player per la capacità nativa in Utilizzare @capgo/capacitor-video-player, e @capgo/capacitor-video-player per il dettaglio di implementazione in @capgo/capacitor-video-player.