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 Setup을 사용할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

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`

__CAPGO_KEEP_0__을 사용하지 않도록 장치의 화면을 어둡게 하기.

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

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

`allowSleep`

__CAPGO_KEEP_0__을 사용하지 않도록 장치의 화면을 어둡게 하기 (장치가 깨어있지 않도록 함).

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

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

`isSupported`

현재 플랫폼에서 __CAPGO_KEEP_0__ 기능이 지원되는지 확인.

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

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

`isKeptAwake`

장치가 현재 __CAPGO_KEEP_0__ 기능으로 깨어있는지 확인.

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

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

Type Reference

`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이 업스트림에서 변경될 때 다시 동기화 하십시오.

Getting Started에서 계속 진행하십시오.

__CAPGO_KEEP_0__을 사용 중이라면 시작하기 API 대시보드와 API 연산을 계획하기 위해, API을 연결하세요. capgo/capacitor-keep-awake를 @capgo/capacitor-keep-awake로 사용하세요. native capability을 위해 @capgo/capacitor-keep-awake를 사용하는 경우 capgo Overview를 참조하세요. API Overview API 구현 세부 정보를 참조하세요. 소개 소개 구현 세부 정보를 참조하세요. API Keys API Keys 구현 세부 정보를 참조하세요. __CAPGO_KEEP_0__ __CAPGO_KEEP_1__