LiveActivity class

Flutter plugin for Live Activities and Dynamic Island.

iOS 16.1+ Live Activities + Android heads-up notifications.

// Basic
await LiveActivity.start(id: 'o1', data: data);

// With alert on update
await LiveActivity.update(id: 'o1', data: data, alert: LiveActivityAlert(title: 'Ready!'));

// End with delay
await LiveActivity.end('o1', policy: LiveActivityDismissalPolicy.afterDuration, duration: Duration(hours: 1));

// Reactive stream
LiveActivity.run(id: 'o2', stream: orderStream.map((o) => data));

// Timer countdown
LiveActivity.timer(id: 't1', title: 'Delivery', duration: Duration(minutes: 15));

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

allIds Future<List<String>>
no setter
frequentPushesEnabled Future<bool>
no setter
isSupported Future<bool>
no setter
onAction Stream<String>
no setter
onPushToken Stream<String>
no setter

Static Methods

end(String id, {LiveActivityData? finalContent, LiveActivityDismissalPolicy policy = LiveActivityDismissalPolicy.immediate, Duration? duration}) Future<bool>
endAll() Future<bool>
getPushToken() Future<String?>
run({required String id, required Stream<LiveActivityData> stream, bool autoEnd = true, void onError(Object error)?}) StreamSubscription<LiveActivityData>
start({required String id, required LiveActivityData data}) Future<bool>
startWithActions({required String id, required LiveActivityData data, Map<String, String> actions = const {}}) Future<bool>
timer({required String id, required String title, String? subtitle, required Duration duration, void onExpired()?}) Future<StreamSubscription<void>>
update({required String id, required LiveActivityData data, LiveActivityAlert? alert}) Future<bool>