Getting Started

このプラグインのインストールステップとフルマークダウンガイドのセットアッププロンプトをコピーできます。

        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.

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。次のコマンドを使用して、CapgoスキルをAIツールに追加します。

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

次のプロンプトを使用してください:

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

Manualセットアップを使用する場合は、以下のコマンドを実行して、プラットフォーム固有の指示に従ってください。

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

Import

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`

画面を暗くする (keep awakeを無効にする)

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

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

`isSupported`

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

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

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

`isKeptAwake`

現在、デバイスがkeep awakeされているかどうかを確認する

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 から続けてください。

あなたが使用している場合 Getting Started API を使用してダッシュボードと API の操作を計画する場合、API を __CAPGO_KEEP_1__-keep-awake と接続してください。 Using @capgo/capacitor-keep-awake Using @capgo/capacitor-keep-awake API Overview API Overview Introduction Introduction API キー実装詳細の API キーについてデバイスデバイスの実装詳細について