はじめに

インストール

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

インポート

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

API オーバービュー

keepAwake

コピー

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

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

allowSleep

画面を暗くし、スリープを許可する (常時起動を無効にする).

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

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

isSupported

現在のプラットフォームで常時起動機能がサポートされているかどうかを確認する.

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

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

isKeptAwake

現在、デバイスが常時起動中であるかどうかを確認する.

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

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

型の参照

IsSupportedResult

isSupported() メソッドの結果。

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

IsKeptAwakeResult

isKeptAwake() メソッドの結果。

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

真実の源

このページはプラグインの src/definitions.ts API の上流で公開された場合に再度 Sync を実行してください。

Getting Started から続けて

あなたが使用している場合 スタート APIと連携するためにダッシュボードとAPIの運用を計画する @capgo/capacitor-keep-awakeを使用する native capabilityの実装詳細については、@capgo/capacitor-keep-awakeを使用する APIの概要 APIの実装詳細については、APIの概要を参照する 導入 実装詳細については、導入を参照する APIのキー APIのキーと実装詳細については、APIのキーを参照する デバイス 実装詳細については、デバイスを参照する