开始获取

安装

您可以使用我们的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. 当 upstream 的 API 变更时，请重新运行同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到 使用 @capgo/capacitor-keep-awake 用于在 Using @capgo/capacitor-keep-awake 中实现的本机功能 API Overview 用于在 API Overview 中实现的详细信息 介绍 用于在介绍中实现的详细信息 API 键 用于实现细节的 API 键，和 设备 用于实现细节的设备。