Getting Started

Copiez une invitation de configuration avec les étapes d'installation et la guide markdown complet pour ce 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.

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

`keepAwake`

Prévenir l'appareil de diminuer l'écran.

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

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

`allowSleep`

Autoriser l'appareil à diminuer l'écran (désactiver le maintien éveillé).

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

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

`isSupported`

Vérifier si la fonctionnalité du maintien éveillé est prise en charge sur la plateforme actuelle.

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

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

`isKeptAwake`

Vérifier si l'appareil est actuellement maintenu éveillé.

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

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

Référence de type

`IsSupportedResult`

Résultat de la méthode isSupported().

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

`IsKeptAwakeResult`

Résultat de la méthode isKeptAwake().

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

Source de Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque les modifications publiques API se produisent en amont.

Continuez de Getting Started

Si vous utilisez Accueil pour planifier le tableau de bord et les opérations API, connectez-le à Utilisez @capgo/capacitor-keep-awake pour la capacité native dans Utilisez @capgo/capacitor-keep-awake, API : Présentation pour les détails d'implémentation dans API : Présentation, Introduction pour les détails d'implémentation dans Introduction, API : Clés pour les détails d'implémentation dans API : Clés, et Appareils pour le détail d'implémentation dans Appareils.