Flutter用户注意力管理插件macos_user_attention的使用

macos_user_attention 是一个用于 macOS 用户注意力管理的 Flutter 插件。

开始使用

第一步：将插件添加到 pubspec.yaml

在你的项目中打开 pubspec.yaml 文件，并添加以下依赖：

dependencies:
  macos_user_attention:

保存文件后运行 flutter pub get 以安装该插件。

第二步：初始化 MacosUserAttention

在你的 Dart 文件中导入 macos_user_attention 包并初始化 MacosUserAttention 对象：

import 'package:macos_user_attention/macos_user_attention.dart';

final _plugin = MacosUserAttention();

请求用户注意力

该插件提供了两种类型的请求：关键请求（critical）和信息请求（informational）。

关键请求

final requestId = await _plugin.requestUserAttention(
  RequestUserAttentionType.critical,
);

信息请求

final requestId = await _plugin.requestUserAttention(
  RequestUserAttentionType.informational,
);

取消请求

取消请求时，你需要传递上次请求的 ID：

await _plugin.cancelAttentionRequest(requestId);

注意事项

• 你只能在应用未获得焦点时请求用户注意。

完整示例代码

以下是一个完整的示例代码，展示了如何使用 macos_user_attention 插件来请求和取消用户注意力。

import 'dart:async';
import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:macos_user_attention/macos_user_attention.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  int? lastRequestId;
  final _macosUserAttentionPlugin = MacosUserAttention();

  [@override](/user/override)
  void initState() {
    super.initState();
    requestCriticalAttention();
  }

  Future<void> requestCriticalAttention() async {
    // 延迟因为请求注意力在前台没有任何意义。
    await Future.delayed(const Duration(seconds: 3));
    // 平台消息可能会失败，所以我们使用 try/catch 来处理 PlatformException。
    // 我们还处理了消息可能返回 null 的情况。
    try {
      lastRequestId = await _macosUserAttentionPlugin.requestUserAttention(
        RequestUserAttentionType.critical,
      );
    } on PlatformException {
      log("Something went wrong");
    }
  }

  Future<void> requestInformationalAttention() async {
    // 延迟因为请求注意力在前台没有任何意义。
    await Future.delayed(const Duration(seconds: 3));
    // 平台消息可能会失败，所以我们使用 try/catch 来处理 PlatformException。
    // 我们还处理了消息可能返回 null 的情况。
    try {
      lastRequestId = await _macosUserAttentionPlugin.requestUserAttention(
        RequestUserAttentionType.informational,
      );
    } on PlatformException {
      log("Something went wrong");
    }
  }

  Future<void> cancelLastRequest() async {
    // 平台消息可能会失败，所以我们使用 try/catch 来处理 PlatformException。
    // 我们还处理了消息可能返回 null 的情况。
    if (lastRequestId == null) {
      log("No request to cancel");
      return;
    }
    try {
      await _macosUserAttentionPlugin.cancelAttentionRequest(lastRequestId!);
    } on PlatformException {
      log("Something went wrong");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Column(
          children: [
            ElevatedButton(
              onPressed: requestCriticalAttention,
              child: const Text("请求关键注意力"),
            ),
            ElevatedButton(
              onPressed: requestInformationalAttention,
              child: const Text("请求信息注意力"),
            ),
          ],
        ),
      ),
    );
  }
}