Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

Importieren

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

Quickstart

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

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

Beispiel: allowSleep

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

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

Beispiel: isSupported

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

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

Häufige Stolperfallen

• Nativer Sync: ausführen bunx cap sync nach Plugin-Upgrades.
• Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

API Übersicht

keepAwake

Verhindert, dass der Bildschirm des Geräts dimmt.

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

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

allowSleep

Erlaubt dem Gerät, den Bildschirm zu dimmen (Keep Awake deaktivieren).

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

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

isSupported

Prüft, ob die Keep-Awake-Funktion auf der aktuellen Plattform unterstützt wird.

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

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

isKeptAwake

Prüft, ob das Gerät aktuell am Einschlafen gehindert wird.

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

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

Typreferenz

IsSupportedResult

Ergebnis der isSupported()-Methode.

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

IsKeptAwakeResult

Ergebnis der isKeptAwake()-Methode.

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-keep-awake verwenden für die native Funktion bei der Nutzung von @capgo/capacitor-keep-awake, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.