Iniziare

Copia una riga di impostazione con i passaggi di installazione e la guida markdown completa per questo plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-keep-awake`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/keep-awake/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installa

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

Importa

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

API Panoramica

`keepAwake`

Prevenire che il dispositivo si spegga lo schermo.

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

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

`allowSleep`

Consenti al dispositivo di spegnere lo schermo (disabilita keep awake).

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

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

`isSupported`

Verifica se il keep awake è supportato sulle attuali piattaforme.

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

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

`isKeptAwake`

Verifica 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;
}

Fonte di Verità

Questa pagina è generata dal plugin e src/definitions.ts. Riavvia la sincronizzazione quando le informazioni pubbliche API cambiano nell'area upstream.

Continua da Inizia a utilizzare

Se stai utilizzando Inizia a utilizzare per pianificare dashboard e API operazioni, connettilo con Usando @capgo/capacitor-keep-awake per la capacità nativa in Usando @capgo/capacitor-keep-awake API Panoramica per il dettaglio di implementazione in API Panoramica Introduzione per il dettaglio di implementazione in Introduzione API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.