Flutter用户引导插件appcues_flutter的使用

appcues_flutter 是一个用于在Flutter应用中集成Appcues用户体验的插件，支持iOS和Android设备。本文将详细介绍如何使用该插件，并提供完整的示例代码。

🚀 快速开始

前置条件

Android

• build.gradle 文件中必须设置 compileSdkVersion 为34+ 和 minSdkVersion 为21+。
• 使用 Android Gradle Plugin (AGP) 8+ 版本。

android {
    compileSdkVersion 34

    defaultConfig {
        minSdkVersion 21
    }
}

由于SDK使用了Jetpack Compose，需要：

1. 在 build.gradle 文件中应用 kotlin-android 插件：

   plugins {  
     id 'com.android.application' 
     id 'kotlin-android' 
   }
   

2. 或者更新 Android Gradle Plugin 到 8.4.0+。

iOS

• 应用程序必须针对 iOS 11+ 进行构建以安装SDK，并且需要针对 iOS 13+ 来渲染Appcues内容。
• 更新Xcode项目中的部署目标，通常在 iOS/Runner.xcodeproj 中进行设置。

# Podfile
platform :ios, '11.0'

安装

在 pubspec.yaml 文件中添加 appcues_flutter 依赖：

dependencies:
  appcues_flutter: <latest_version>

然后运行 flutter pub get 安装依赖。

初始化SDK

在应用程序启动时初始化Appcues SDK实例：

import 'package:appcues_flutter/appcues_flutter.dart';

void main() {
  runApp(MyApp());
  Appcues.initialize('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID');
}

支持Builder预览和屏幕捕获

参考 配置Appcues URL Scheme 文档来完成安装步骤。

启用推送通知

请参阅 iOS 和 Android 的原生文档了解详细信息。example 目录中包含了一个带有推送通知支持的参考实现。

用户识别

为了向正确的用户在正确的时间展示内容，您需要识别用户并向Appcues发送有关他们的数据：

// 识别用户
Appcues.identify('my-user-id');

// 识别用户并传递属性
Appcues.identify('my-user-id', {'Company': 'Appcues'});

识别用户后，可以将其与组关联起来：

// 将用户与组关联，可选地包括组属性
Appcues.group('group-id', {'Plan Tier': 'standard'});

跟踪屏幕和事件

一旦安装并初始化了Appcues Flutter插件，您可以使用以下方法开始跟踪屏幕和事件：

// 跟踪事件
Appcues.track('Sent Message');

// 跟踪带属性的事件
Appcues.track('Deleted Contact', {'ID': 123 });

// 跟踪屏幕
Appcues.screen('Contact List');

// 跟踪带属性的屏幕
Appcues.screen('Contact Details', {'Contact Reference': 'abc'});

示例代码

下面是一个简单的Flutter应用示例，展示了如何集成和使用appcues_flutter插件：

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

void main() {
  runApp(MyApp());
  Appcues.initialize('YOUR_APPCUES_ACCOUNT_ID', 'YOUR_APPCUES_APPLICATION_ID');
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
      // 跟踪事件
      Appcues.track('Increment Counter');
    });
  }

  [@override](/user/override)
  void initState() {
    super.initState();
    // 识别用户
    Appcues.identify('user-123', {'Name': 'John Doe'});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}