API Reference

Import the main package for core APIs, config, and enums:

import 'package:zixflow/zixflow.dart';

Core SDK

`Zixflow.initialize({required ZixflowConfig config}): Future<void>`

Initialize the SDK with configuration. Call once before using other APIs.

await Zixflow.initialize(
  config: ZixflowConfig(apiKey: 'YOUR_API_KEY'),
);

`Zixflow.instance`

Singleton instance. Throws StateError if the SDK has not been initialized.

`Zixflow.instance.identify({required String userId, Map<String, dynamic> traits}): void`

Identify a user. Provide a unique userId and optional traits.

Zixflow.instance.identify(
  userId: 'user-123',
  traits: {'email': 'user@example.com'},
);

`Zixflow.instance.clearIdentify(): void`

Clear the current user’s identity.

Zixflow.instance.clearIdentify();

`Zixflow.instance.track({required String name, Map<String, dynamic> properties}): void`

Track a custom event.

Zixflow.instance.track(
  name: 'button_clicked',
  properties: {'button_name': 'signup'},
);

`Zixflow.instance.screen({required String title, Map<String, dynamic> properties}): void`

Track a screen view.

Zixflow.instance.screen(title: 'HomeScreen');

`Zixflow.instance.setProfileAttributes({required Map<String, dynamic> attributes}): void`

Set attributes on the user profile.

Zixflow.instance.setProfileAttributes(
  attributes: {'plan': 'premium'},
);

`Zixflow.instance.setDeviceAttributes({required Map<String, dynamic> attributes}): void`

Set attributes on the current device.

Zixflow.instance.setDeviceAttributes(
  attributes: {'app_version': '2.0.0'},
);

`Zixflow.instance.registerDeviceToken({required String deviceToken}): void`

Zixflow.instance.registerDeviceToken(deviceToken: token);

`Zixflow.instance.deleteDeviceToken(): void`

Remove the current device token.

Zixflow.instance.deleteDeviceToken();

`Zixflow.instance.trackMetric({required String deliveryID, required String deviceToken, required MetricEvent event}): void`

Track push lifecycle metrics. With the Dart FCM + local-notifications integration, call this for opened (and optionally delivered). See Push Notification Tracking.

Zixflow.instance.trackMetric(
  deliveryID: '626533406292836846',
  deviceToken: token,
  event: MetricEvent.opened, // or MetricEvent.delivered / MetricEvent.converted
);

MetricEvent.converted is for conversion attribution after an open; it is not used by the standard push open/action flow. Action button presses use track(name: 'Push Notification Action Clicked', ...), not trackMetric.

Push Messaging

Native Android helpers for forwarding FCM data messages into the SDK (display and/or delivered tracking). The Dart path in sdk-examples/flutter uses trackMetric / track directly instead of these APIs.

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Future<String?>`

final token = await Zixflow.pushMessaging.getRegisteredDeviceToken();

`Zixflow.pushMessaging.onMessageReceived(Map<String, dynamic> message, {bool handleNotificationTrigger = true}): Future<bool>`

Process an FCM data message on Android (displays and/or tracks). On iOS this resolves to true without additional work. Use when another FCM listener receives the message and you want the native SDK to handle display/tracking.

await Zixflow.pushMessaging.onMessageReceived(message);

`Zixflow.pushMessaging.onBackgroundMessageReceived(Map<String, dynamic> message): Future<bool>`

Background helper around onMessageReceived (Android).

await Zixflow.pushMessaging.onBackgroundMessageReceived(message);

Location

`Zixflow.location.setLastKnownLocation({required double latitude, required double longitude}): void`

Zixflow.location.setLastKnownLocation(
  latitude: 37.7749,
  longitude: -122.4194,
);

`Zixflow.location.requestLocationUpdate(): void`

Zixflow.location.requestLocationUpdate();

Types

`ZixflowConfig`

ZixflowConfig({
  required String apiKey,
  LogLevel? logLevel,
  bool? autoTrackDeviceAttributes,
  bool? trackApplicationLifecycleEvents,
  ScreenView? screenViewUse,
  String? apiHost,
  String? cdnHost,
  int? flushAt,
  int? flushInterval,
  PushConfig? pushConfig,
  LocationConfig? locationConfig,
});

`LogLevel`

enum LogLevel { none, error, info, debug }

`ScreenView`

enum ScreenView { all }

`LocationTrackingMode`

enum LocationTrackingMode { off, manual, onAppStart }

`MetricEvent`

enum MetricEvent { delivered, opened, converted }

`PushClickBehaviorAndroid`

enum PushClickBehaviorAndroid {
  resetTaskStack,
  activityPreventRestart,
  activityNoFlags,
}

`PushConfig` / `PushConfigAndroid`

PushConfig(
  android: PushConfigAndroid(
    pushClickBehavior: PushClickBehaviorAndroid.activityPreventRestart,
  ),
)

`LocationConfig`

LocationConfig(
  trackingMode: LocationTrackingMode.manual,
)

Getting Started

Features

Advanced

Reference

Core SDK

`Zixflow.initialize({required ZixflowConfig config}): Future<void>`

`Zixflow.instance`

`Zixflow.instance.identify({required String userId, Map<String, dynamic> traits}): void`

`Zixflow.instance.clearIdentify(): void`

`Zixflow.instance.track({required String name, Map<String, dynamic> properties}): void`

`Zixflow.instance.screen({required String title, Map<String, dynamic> properties}): void`

`Zixflow.instance.setProfileAttributes({required Map<String, dynamic> attributes}): void`

`Zixflow.instance.setDeviceAttributes({required Map<String, dynamic> attributes}): void`

`Zixflow.instance.registerDeviceToken({required String deviceToken}): void`

`Zixflow.instance.deleteDeviceToken(): void`

`Zixflow.instance.trackMetric({required String deliveryID, required String deviceToken, required MetricEvent event}): void`

Push Messaging

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Future<String?>`

`Zixflow.pushMessaging.onMessageReceived(Map<String, dynamic> message, {bool handleNotificationTrigger = true}): Future<bool>`

`Zixflow.pushMessaging.onBackgroundMessageReceived(Map<String, dynamic> message): Future<bool>`

Location

`Zixflow.location.setLastKnownLocation({required double latitude, required double longitude}): void`

`Zixflow.location.requestLocationUpdate(): void`

Types

`ZixflowConfig`

`LogLevel`

`ScreenView`

`LocationTrackingMode`

`MetricEvent`

`PushClickBehaviorAndroid`

`PushConfig` / `PushConfigAndroid`

`LocationConfig`

​Core SDK

​Zixflow.initialize({required ZixflowConfig config}): Future<void>

​Zixflow.instance

​Zixflow.instance.identify({required String userId, Map<String, dynamic> traits}): void

​Zixflow.instance.clearIdentify(): void

​Zixflow.instance.track({required String name, Map<String, dynamic> properties}): void

​Zixflow.instance.screen({required String title, Map<String, dynamic> properties}): void

​Zixflow.instance.setProfileAttributes({required Map<String, dynamic> attributes}): void

​Zixflow.instance.setDeviceAttributes({required Map<String, dynamic> attributes}): void

​Zixflow.instance.registerDeviceToken({required String deviceToken}): void

​Zixflow.instance.deleteDeviceToken(): void

​Zixflow.instance.trackMetric({required String deliveryID, required String deviceToken, required MetricEvent event}): void

​Push Messaging

​Zixflow.pushMessaging.getRegisteredDeviceToken(): Future<String?>

​Zixflow.pushMessaging.onMessageReceived(Map<String, dynamic> message, {bool handleNotificationTrigger = true}): Future<bool>

​Zixflow.pushMessaging.onBackgroundMessageReceived(Map<String, dynamic> message): Future<bool>

​Location

​Zixflow.location.setLastKnownLocation({required double latitude, required double longitude}): void

​Zixflow.location.requestLocationUpdate(): void

​Types

​ZixflowConfig

​LogLevel

​ScreenView

​LocationTrackingMode

​MetricEvent

​PushClickBehaviorAndroid

​PushConfig / PushConfigAndroid

​LocationConfig

Core SDK

`Zixflow.initialize({required ZixflowConfig config}): Future<void>`

`Zixflow.instance`

`Zixflow.instance.identify({required String userId, Map<String, dynamic> traits}): void`

`Zixflow.instance.clearIdentify(): void`

`Zixflow.instance.track({required String name, Map<String, dynamic> properties}): void`

`Zixflow.instance.screen({required String title, Map<String, dynamic> properties}): void`

`Zixflow.instance.setProfileAttributes({required Map<String, dynamic> attributes}): void`

`Zixflow.instance.setDeviceAttributes({required Map<String, dynamic> attributes}): void`

`Zixflow.instance.registerDeviceToken({required String deviceToken}): void`

`Zixflow.instance.deleteDeviceToken(): void`

`Zixflow.instance.trackMetric({required String deliveryID, required String deviceToken, required MetricEvent event}): void`

Push Messaging

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Future<String?>`

`Zixflow.pushMessaging.onMessageReceived(Map<String, dynamic> message, {bool handleNotificationTrigger = true}): Future<bool>`

`Zixflow.pushMessaging.onBackgroundMessageReceived(Map<String, dynamic> message): Future<bool>`

Location

`Zixflow.location.setLastKnownLocation({required double latitude, required double longitude}): void`

`Zixflow.location.requestLocationUpdate(): void`

Types

`ZixflowConfig`

`LogLevel`

`ScreenView`

`LocationTrackingMode`

`MetricEvent`

`PushClickBehaviorAndroid`

`PushConfig` / `PushConfigAndroid`

`LocationConfig`