Flutter用户同意管理插件stun_consent的使用

用户同意管理插件stun_consent

用户同意管理插件用于获取用户对收集个人数据的许可。

国际化

有关俄语文档，请参阅此链接。

开始使用

在 pubspec.yaml 文件的 dependencies 部分添加以下行：

dependencies:
  stun_consent: <latest-version>

然后运行命令：

flutter pub get

导入库：

import 'package:stun_consent/stun_consent.dart';

创建一个名为 content.json 的文件，并将其放在 assets 文件夹中。以下是 content.json 文件的结构示例。请替换为您的内容。

{
    "title": "亲爱的用户!",
    "articles": [
        "我们使用广告来赚取一些收入，以便为您提供更有用的应用。",
        "应用启动时只会展示一条广告，您可以跳过这条广告，广告不会在使用应用期间打扰您。",
        "为了正确地运行应用、个性化广告以及收集统计数据，我们需要收集一些匿名的数据。",
        "您可以通过设备的隐私设置选择不分享这些数据。",
        "关于我们和合作伙伴收集的数据详情、如何存储和使用这些数据的信息，请参阅以下隐私政策链接。"
    ],
    "app_policy": "https://stun-apps.com",
    "partners_policy": {
        "《<您的公司名称>》隐私政策": "https://stun-apps.com",
        "《<您的公司名称>》合作伙伴的隐私政策": "https://stun-apps.com"
    }
}

使用示例

ConsentConfig 类

该类负责屏幕的外观。

ConsentConfig 属性

const kContentPath = 'assets/content.json';
const kAppIconPath = 'assets/ic_launcher.png';

ConsentConfig({
    required this.appName,
    this.backgroundColor = const Color(0xffe3e7e8),
    this.footerColor = Colors.white,
    this.textColor = const Color(0xff0c2e43),
    this.accentColor = const Color(0xff5be769),
    this.buttonTextColor = const Color(0xff0c2e43),
    this.appIconPath = kAppIconPath,
    this.contentPath = kContentPath,
    this.onRequestPermissions,
});

ConsentConfig.dark({
    required this.appName,
    this.backgroundColor = const Color(0xFF212223),
    this.footerColor = const Color(0x19000000),
    this.textColor = Colors.white,
    this.accentColor = const Color(0xFF27AE35),
    this.buttonTextColor = const Color(0xFF232425),
    this.appIconPath = kAppIconPath,
    this.contentPath = kContentPath,
    this.onRequestPermissions,
});

显示屏幕

要显示屏幕，请使用 StunConsent.showConsent 方法。

final config = ConsentConfig(
    appName: 'Stun Consent Demo App',
  onRequestPermissions: () async {
    // 添加请求权限的代码（例如请求访问相机的权限）
  },
);

final hasConsent = await StunConsent.showConsent(context, config);

hasConsent 变量将包含用户是否已同意。

屏幕仅在缓存清除或应用重新安装后才会再次显示。

其他功能

final hasConsent = await StunConsent.hasUserConsent; // 检查用户是否已同意
final wasShown = await StunConsent.dialogWasShown; // 检查屏幕是否已显示

调试

要启用调试/日志模式，请使用 enableDebug 方法。默认情况下，它处于禁用状态。

在调试模式下，每次调用 showConsent 方法时都会显示屏幕。

StunConsent.enableDebug(true);

示例

完整的使用示例如下：

import 'package:flutter/material.dart';
import 'package:stun_consent/stun_consent.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  bool _hasConsent = false;
  bool _wasShown = false;

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

  Future<void> _init() async {
    StunConsent.enableDebug(true);
    _hasConsent = await StunConsent.hasUserConsent;
    _wasShown = await StunConsent.dialogWasShown;
    setState(() {});
  }

  Future<void> _showConsent() async {
    await StunConsent.showConsent(
      context,
      ConsentConfig(
        appIconPath: 'assets/ic_launcher.png',
        appName: 'Stun Consent Demo App',
        contentPath: 'assets/content.json',
        onRequestPermissions: () async {},
      ),
    );
    _hasConsent = await StunConsent.hasUserConsent;
    _wasShown = await StunConsent.dialogWasShown;
    setState(() {});
  }

  Future<void> _showDarkConsent() async {
    await StunConsent.showConsent(
      context,
      ConsentConfig.dark(
        appIconPath: 'assets/ic_launcher.png',
        appName: 'Stun Consent Demo App',
        contentPath: 'assets/content.json',
      ),
    );
    _hasConsent = await StunConsent.hasUserConsent;
    _wasShown = await StunConsent.dialogWasShown;
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Stun Consent Demo App'),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          Row(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: _showConsent,
                child: const Text('显示同意屏幕'),
              ),
              const SizedBox(width: 16),
              ElevatedButton(
                onPressed: _showDarkConsent,
                child: const Text('显示暗色同意屏幕'),
              ),
            ],
          ),
          const SizedBox(height: 16),
          Text('用户是否同意: $_hasConsent'),
          const SizedBox(height: 16),
          Text('屏幕是否已显示: $_wasShown'),
        ],
      ),
    );
  }
}