Flutter插件contlo_plugin的安装与使用

Flutter插件contlo_plugin的安装与使用

Contlo Flutter SDK

引言

Contlo支持将您的Flutter应用程序与Flutter SDK集成，以启用推送通知、事件、分析、自动化等功能。

Flutter插件contlo_plugin的安装

要在您的Flutter项目中使用此插件，将其添加到pubspec.yaml文件中：

dependencies:
  contlo_plugin: ^1.0.0

运行flutter pub get以安装SDK。

现在，您可以在Dart代码中使用以下导入语句：

import 'package:contlo_plugin/contlo_plugin.dart';

您可以使用ContloPlugin来发送用户数据或自定义事件到Contlo。

注意：ContloPlugin中的所有方法都是异步的，这意味着您必须使用async和await调用它们。

初始化Contlo插件

要初始化Contlo插件，您需要在应用程序启动时调用此方法。通常这意味着您需要在runApp()代码之后添加该代码：

ContloPlugin.init("<Your API KEY>")

发送用户详细信息到Contlo

您可以使用Contlo插件将用户详细信息发送到Contlo。

Future<void> sendUserDetails() async {
  try {
    print("Send user: $email, $phone, $name, $city");
    String data = await ContloPlugin.sendUserDetail({
      "email": email,
      "phone_number": phone,
      "first_name": name.isEmpty ? "aman" : name,
      "city": city.isEmpty ? "ranchi" : city,
      "custom_properties": {
        'key': 'value'
      }
    });
    print("User details response: $data");
  } on PlatformException catch (e) {
    print("Exception thrown $e");
  }
}

发送事件到Contlo

Contlo插件还允许您将自定义事件发送到Contlo。以下是如何发送事件的示例：

void sendEvent() async {
  String data = await ContloPlugin.sendEvent({
    "event": eventName,
    "properties": {
      eventDetails['key']: eventDetails['value']
    }
  });
  print("Event response: $data");
}

一种更简单的方法是：

ContloPlugin.sendEvent("eventName");

发送推送同意到Contlo

从Android 13及以上版本开始，您需要明确请求用户同意接收推送通知。

在您的AndroidManifest.xml文件中添加以下权限：

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

如果设备使用的是Android 12或更低版本，则发送通知的权限已经授予。如果设备使用的是Android 13或更高版本，您需要明确请求用户的许可。

根据用户同意使用以下代码：

ContloPlugin.subscribeToMobilePush(<consent>)

基于收到的同意，该函数将在您的Contlo仪表板上订阅或取消订阅您的受众的移动推送。

广告ID跟踪

如果您想跨设备跟踪匿名用户，可以启用广告ID跟踪。这将在您的Contlo仪表板上的联系人详情下的受众部分设置广告ID作为个人资料属性。按照以下步骤操作：

在您的AndroidManifest.xml文件中添加以下权限：

<uses-permission android:name="com.google.android.gms.ads.permission.AD_ID" />

在您的Flutter代码中启用广告ID跟踪：

ContloPlugin.sendAdvertisingId(true)

示例代码

以下是完整的示例代码：

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

import 'package:flutter/services.dart';
import 'package:contlo_plugin/contlo_plugin.dart';
import 'package:permission_handler/permission_handler.dart';

import 'user_screen.dart';
import 'dummy_event_screen.dart';
import 'event_screen.dart';

final API_KEY = "e33f4af9ea34b73f18c0fe46d02ed1a2";

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

Future<void> requestNotificationPermission() async {
  // 请求通知权限
  final status = await Permission.notification.request();

  if (status.isGranted) {

  } else if (status.isDenied) {

  } else if (status.isPermanentlyDenied) {
    openAppSettings();
  }
}

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

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

class HomePage extends StatelessWidget {
  String _platformVersion = 'Unknown';
  final _contloPlugin = ContloPlugin();
  HomePage() {
    init();
  }

  void init() async {
    String? dd = await ContloPlugin.init(API_KEY) as String?;
    print("initialized contlo: $dd");
    // 添加您的代码以处理第三按钮
  }

  // 平台消息是异步的，所以我们初始化时使用异步方法。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能会失败，所以我们使用try/catch处理PlatformException。
    // 我们也处理消息可能返回null的情况。
    try {
      platformVersion = await ContloPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // 如果小部件在异步平台消息仍在进行时从树中被移除，我们希望丢弃回复而不是调用setState更新我们的非存在的外观。
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Contlo Plugin'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center, // 将按钮垂直居中对齐
            children: <Widget>[
              ElevatedButton(
                onPressed: () {
                  Navigator.push(context, MaterialPageRoute(builder: (context) => UserScreen()));
                },
                child: Text('Send User Detail'),
              ),
              ElevatedButton(
                onPressed: () async {
                  String? dd = await ContloPlugin.sendAdvertisingId(true);
                  print("Advertising ID: $dd");
                  // 添加您的代码以处理第三按钮
                },
                child: Text('Send Advertising ID'),
              ),
              ElevatedButton(
                onPressed: () {
                  Navigator.push(context, MaterialPageRoute(builder: (context) => DummyEventScreen()));
                },
                child: Text('Dummy Events'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}