Flutter事件追踪插件at_events_flutter的使用

Flutter事件追踪插件at_events_flutter的使用

概述

at_events_flutter 包适用于希望在其应用中集成事件管理功能的Flutter开发者。这个开源包用Dart编写，支持Flutter，并遵循atPlatform的去中心化、边缘计算模型，具有以下特性：

• 通过个人数据存储实现数据访问的加密控制
• 不需要应用程序后端
• 端到端加密，只有数据所有者拥有密钥
• 私有且无监控连接
• 创建和更新带有位置和参与者的事件

开始使用

快速开始 - 使用 at_app 生成骨架应用

此包包含一个工作示例应用程序在Example目录中，你可以使用at_app create命令创建个性化副本。

$ flutter pub global activate at_app 
$ at_app create --sample=<package ID> <app name> 
$ cd <app name>
$ flutter run

注意：

1. 你只需要运行flutter pub global activate一次。
2. 对于Windows，请使用at_app.bat。

从GitHub克隆

可以从GitHub仓库克隆源代码。示例代码与上面提到的模板相同。

$ git clone https://github.com/atsign-foundation/at_widgets.git

手动添加包到项目

可以在pub.dev上找到手动添加包的说明。

如何工作

设置

初始化

应用程序首先应使用Onboarding小部件验证atsign。事件服务需要使用必需的GlobalKey进行初始化。

initialiseEventService(
  navKey,
  mapKey: 'xxxx', // 地图API密钥
  apiKey: 'xxxx',  // ETA计算API密钥
  rootDomain: 'root.atsign.org',
  streamAlternative: (__){},
  initLocation: true, // 是否初始化位置服务
);

由于该包需要位置权限，请在以下位置添加相应配置：

iOS (ios/Runner/Info.plist)

<key>NSLocationWhenInUseUsageDescription</key>
<string>解释描述内容。</string>

Android (android/app/src/main/AndroidManifest.xml)

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

at_events_flutter 依赖 at_location_flutter 实现以下功能：

• 发送/接收位置，如果需要位置共享，则需初始化 at_location_flutter。
• 渲染地图，如果需要地图，则将 mapKey 传递给 initializeLocationService。
• 计算ETA，如果需要ETA，则将 apiKey 传递给 initializeLocationService。

使用

要创建新事件，可以使用默认屏幕：

CreateEvent(
  AtClientManager.getInstance(),
),

使用事件创建/编辑功能时，确保先调用 EventService().init()：

• createEvent() - 根据 isEventUpdate 参数创建或编辑事件
• editEvent() - 更新已创建的事件
• sendEventNotification() - 创建新事件

导航到事件的地图屏幕：

EventsMapScreenData().moveToEventScreen(eventNotificationModel);

不同数据类型：

• EventNotificationModel：包含事件详情并发送给atsigns。
• EventKeyLocationModel：用于跟踪所有事件通知。

获取 mapKey 和 apiKey

• mapKey 可以从 MapTiler 获取。
• apiKey 可以从 HERE Developer 获取。

示例代码

以下是完整的示例demo代码：

import 'dart:async';
import 'package:at_app_flutter/at_app_flutter.dart' show AtEnv;
import 'package:at_client_mobile/at_client_mobile.dart';
import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart' show getApplicationSupportDirectory';

Future<void> main() async {
  await AtEnv.load();
  runApp(const MyApp());
}

Future<AtClientPreference> loadAtClientPreference() async {
  var dir = await getApplicationSupportDirectory();
  return AtClientPreference()
    ..rootDomain = AtEnv.rootDomain
    ..namespace = AtEnv.appNamespace
    ..hiveStoragePath = dir.path
    ..commitLogPath = dir.path
    ..isLocalStoreRequired = true;
}

final StreamController<ThemeMode> updateThemeMode = StreamController<ThemeMode>.broadcast();

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

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

class _MyAppState extends State<MyApp> {
  Future<AtClientPreference> futurePreference = loadAtClientPreference();
  AtClientPreference? atClientPreference;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return StreamBuilder<ThemeMode>(
      stream: updateThemeMode.stream,
      initialData: ThemeMode.light,
      builder: (BuildContext context, AsyncSnapshot<ThemeMode> snapshot) {
        ThemeMode themeMode = snapshot.data ?? ThemeMode.light;
        return MaterialApp(
          navigatorKey: NavService.navKey,
          theme: ThemeData().copyWith(
            brightness: Brightness.light,
            primaryColor: const Color(0xFFf4533d),
            colorScheme: ThemeData.light().colorScheme.copyWith(primary: const Color(0xFFf4533d), surface: Colors.white),
            scaffoldBackgroundColor: Colors.white,
          ),
          darkTheme: ThemeData().copyWith(
            brightness: Brightness.dark,
            primaryColor: Colors.blue,
            colorScheme: ThemeData.dark().colorScheme.copyWith(primary: Colors.blue, surface: Colors.grey[850]),
            scaffoldBackgroundColor: Colors.grey[850],
          ),
          themeMode: themeMode,
          home: Scaffold(
            appBar: AppBar(
              title: const Text('MyApp'),
              actions: <Widget>[
                IconButton(
                  onPressed: () {
                    updateThemeMode.sink.add(themeMode == ThemeMode.light ? ThemeMode.dark : ThemeMode.light);
                  },
                  icon: Icon(
                    Theme.of(context).brightness == Brightness.light
                        ? Icons.dark_mode_outlined
                        : Icons.light_mode_outlined,
                  ),
                )
              ],
            ),
            body: Builder(
              builder: (context) => Center(
                child: Column(
                  mainAxisAlignment: MainAxisAlignment.center,
                  children: [
                    ElevatedButton(
                      onPressed: () async {
                        var preference = await futurePreference;
                        setState(() {
                          atClientPreference = preference;
                        });
                        if (context.mounted) {
                          final result = await AtOnboarding.onboard(
                            context: context,
                            config: AtOnboardingConfig(
                              atClientPreference: atClientPreference!,
                              domain: AtEnv.rootDomain,
                              rootEnvironment: AtEnv.rootEnvironment,
                              appAPIKey: AtEnv.appApiKey,
                            ),
                          );
                          switch (result.status) {
                            case AtOnboardingResultStatus.success:
                              Navigator.push(context, MaterialPageRoute(builder: (_) => const SecondScreen()));
                              break;
                            case AtOnboardingResultStatus.error:
                              ScaffoldMessenger.of(context).showSnackBar(
                                const SnackBar(
                                  backgroundColor: Colors.red,
                                  content: Text('An error has occurred'),
                                ),
                              );
                              break;
                            case AtOnboardingResultStatus.cancel:
                              break;
                          }
                        }
                      },
                      child: const Text('Onboard an atSign'),
                    ),
                    const SizedBox(height: 10),
                    ElevatedButton(
                      onPressed: () async {
                        var preference = await futurePreference;
                        atClientPreference = preference;
                        if (context.mounted) {
                          AtOnboarding.reset(
                            context: context,
                            config: AtOnboardingConfig(
                              atClientPreference: atClientPreference!,
                              domain: AtEnv.rootDomain,
                              rootEnvironment: AtEnv.rootEnvironment,
                              appAPIKey: AtEnv.appApiKey,
                            ),
                          );
                        }
                      },
                      child: const Text('Reset'),
                    ),
                  ],
                ),
              ),
            ),
          ),
        );
      },
    );
  }
}

class NavService {
  static GlobalKey<NavigatorState> navKey = GlobalKey();
}