Iniziare

Installare

Potresti utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo abilità al tuo strumento 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-keep-awake` plugin in my project.

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

bun add @capgo/capacitor-keep-awake
bunx cap sync

Importa

import { KeepAwake } from '@capgo/capacitor-keep-awake';

Panoramica di API

keepAwake

Prevenire che il dispositivo abbassi la luminosità dello schermo.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.keepAwake();
console.log('Screen will stay awake');

allowSleep

Consentire al dispositivo di abbassare la luminosità dello schermo (disabilitare keep awake).

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.allowSleep();
console.log('Screen can now dim');

isSupported

Verificare se il keep awake è supportato sulla piattaforma corrente.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isSupported } = await KeepAwake.isSupported();
if (isSupported) {
  console.log('Keep awake is supported');
}

isKeptAwake

Verificare se il dispositivo è attualmente tenuto sveglio.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isKeptAwake } = await KeepAwake.isKeptAwake();
console.log('Is kept awake:', isKeptAwake);

Riferimento di tipo

IsSupportedResult

Risultato del metodo isSupported().

export interface IsSupportedResult {
  /**
   * Whether keep awake is supported on the current platform.
   *
   * @since 1.0.0
   */
  isSupported: boolean;
}

IsKeptAwakeResult

Risultato del metodo isKeptAwake().

export interface IsKeptAwakeResult {
  /**
   * Whether the device is currently being kept awake.
   *
   * @since 1.0.0
   */
  isKeptAwake: boolean;
}

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.ts. Risciacqua la sincronizzazione quando le informazioni pubbliche API cambiano in alto.

Continua da Iniziare

Se stai utilizzando Iniziare per pianificare il pannello di controllo e le operazioni API, collega il pannello di controllo con Utilizzare @capgo/capacitor-keep-awake per la capacità nativa in Utilizzare @capgo/capacitor-keep-awake API Overview per la dettaglio di implementazione in API Overview Introduzione per la dettaglio di implementazione in Introduzione API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.