Getting Started

Installazione

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

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

Poi utilizza il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-webview-guardian` 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-webview-guardian
bunx cap sync

Importa

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

Avvio rapido

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.startMonitoring();
console.log(result);

Esempio: fermare la monitoraggio

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.stopMonitoring();
console.log(result);

Esempio: getState

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.getState();
console.log(result);

Trappole comuni

• Difficoltà comuniSezione intitolata “Difficoltà comuni”
• Ascoltatori: run bunx cap sync Sincronizzazione nativa
• Verità di riferimento: trust src/definitions.ts nel repository GitHub.

Panoramica di API

startMonitoring

Inizia a monitorare gli eventi in primo piano e controlla automaticamente la salute del WebView.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.startMonitoring();
console.log(result);

stopMonitoring

Sospende la monitorazione automatica in primo piano.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.stopMonitoring();
console.log(result);

getState

Restituisce lo stato di monitoraggio più recente.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.getState();
console.log(result);

checkNow

Forza un probe di salute per WebView immediatamente.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

const result = await WebviewGuardian.checkNow();
console.log(result);

Riferimento di Tipo

StartMonitoringOptions

export interface StartMonitoringOptions {
  /**
   * Delay (in ms) before running a health check after the app re-enters the foreground.
   * Defaults to 600ms to let the bridge finish resuming.
   */
  foregroundDebounceMs?: number;

  /**
   * Script executed via `evaluateJavascript`/`evaluateJavaScript` to confirm the WebView is alive.
   * Defaults to `document.readyState`.
   */
  pingScript?: string;

  /**
   * Automatically reloads the WebView when a terminated render process is detected.
   * Disable to receive `webviewCrashed` events and restart manually.
   */
  autoRestart?: boolean;

  /**
   * Strategy used when restarting the WebView. Defaults to `reload`.
   */
  restartStrategy?: RestartStrategy;

  /**
   * Custom HTTPS/HTTP URL to load when `restartStrategy` is `customUrl`.
   */
  customRestartUrl?: string;

  /**
   * Emits verbose logging in the native layer when true.
   */
  debug?: boolean;

  /**
   * Whether an immediate health check should be executed right after enabling monitoring.
   * Defaults to `true`.
   */
  runInitialCheck?: boolean;
}

GuardianState

export interface GuardianState {
  monitoring: boolean;
  reason: string;
  timestamp: string;
  lastHealthyAt?: string;
  lastRestartAt?: string;
  lastCrashAt?: string;
  pendingRestartReason?: string;
  error?: string;
}

CheckNowOptions

export interface CheckNowOptions {
  /**
   * Text tag describing why a manual check is being requested.
   */
  reason?: string;
}

CheckResult

export interface CheckResult {
  healthy: boolean;
  restarted: boolean;
  reason: string;
  timestamp: string;
  error?: string;
  pendingRestart?: boolean;
}

GuardianEvent

export type GuardianEvent = GuardianState;

RestartStrategy

export type RestartStrategy = 'reload' | 'reloadFromOrigin' | 'customUrl';

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Continua da qui: Iniziare

Se stai utilizzando Avvio rapido per pianificare il comportamento dei media nativi e dell'interfaccia, connettilo con Utilizzare @capgo/capacitor-webview-guardian per la capacità nativa in Utilizzare @capgo/capacitor-webview-guardian, Utilizzare @capgo/capacitor-live-attività 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-player-video per il dettaglio di implementazione in @capgo/capacitor-video-player.