startActivity static method

Future<LiveActivityHandle> startActivity({
  1. required String title,
  2. required Map<String, dynamic> data,
  3. String? appGroup,
})

Start a new Live Activity. Returns a LiveActivityHandle with the activityId.

data is a flat map of String keys to String/int/double/bool values. Your SwiftUI widget extension reads these by key.

appGroup is required if you share data via UserDefaults with the widget extension.

Implementation

static Future<LiveActivityHandle> startActivity({
  required String title,
  required Map<String, dynamic> data,
  String? appGroup,
}) async {
  final id = await FlutterLiveActivitiesPlatform.instance.startActivity(
    title: title,
    data: data,
    appGroup: appGroup,
  );
  return LiveActivityHandle(id);
}