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.

설치

AI-Assisted 설치를 사용하여 플러그인을 설치할 수 있습니다. 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 Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

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. upstream API을 다시 동기화할 때

시작하기

만약에 시작하기 대시보드와 API 운영을 계획하고 싶다면 @capgo/capacitor-keep-awake native 기능을 사용하기 위해 @capgo/capacitor-keep-awake API 개요 API 개요 소개 소개 API 키 implementation 세부 사항에 대한 API 키 장치 implementation 세부 사항에 대한 장치