Getting Started

复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。

        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辅助设置来安装插件。使用以下命令将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.

如果您更喜欢手动设置，请运行以下命令并按照以下平台特定的说明进行操作:

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发生了上游的变化。

继续从Getting Started

如果您正在使用 Getting Started 来规划仪表板和API操作，连接它到使用@capgo/capacitor-keep-awake 为native能力在使用@capgo/capacitor-keep-awake API概述为API概述中的实现细节介绍为介绍中的实现细节 API 键了解API 键的实现细节，以及设备了解设备的实现细节。