76 lines
2.3 KiB
Dart
76 lines
2.3 KiB
Dart
import 'dart:async';
|
|
import 'package:flutter/material.dart';
|
|
import '../utils/watch_state_notifier.dart';
|
|
import 'event_aware.dart';
|
|
|
|
/// Mixin for screens that need to react to watch state changes.
|
|
///
|
|
/// Provides automatic subscription management and filtering based on
|
|
/// which items the screen cares about.
|
|
///
|
|
/// Example usage:
|
|
/// ```dart
|
|
/// class _MyScreenState extends State<MyScreen> with WatchStateAware {
|
|
/// List<MediaItem> _items = [];
|
|
///
|
|
/// @override
|
|
/// Set<String>? get watchedIds =>
|
|
/// _items.map((e) => e.id).toSet();
|
|
///
|
|
/// @override
|
|
/// void onWatchStateChanged(WatchStateEvent event) {
|
|
/// // Refresh affected item
|
|
/// _refreshItem(event.itemId);
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
mixin WatchStateAware<T extends StatefulWidget> on State<T> {
|
|
StreamSubscription<WatchStateEvent>? _watchStateSubscription;
|
|
|
|
/// Override to scope events to a specific server.
|
|
///
|
|
/// Return null to receive events from all servers.
|
|
String? get watchStateServerId => null;
|
|
|
|
/// Override to specify which global keys this screen cares about.
|
|
///
|
|
/// Use format `serverId:ratingKey`.
|
|
/// Return null to fall back to [watchedIds] matching.
|
|
Set<String>? get watchedGlobalKeys => null;
|
|
|
|
/// Override to specify which item ids this screen cares about.
|
|
///
|
|
/// Return null to receive ALL events (not recommended for performance).
|
|
/// Return an empty set to receive no events.
|
|
///
|
|
/// The set should include:
|
|
/// - Direct items displayed (e.g., episode ids in a season view)
|
|
/// - Parent items that affect display (e.g., show id for on-deck)
|
|
Set<String>? get watchedIds;
|
|
|
|
/// Called when a relevant watch state change occurs.
|
|
///
|
|
/// Only called if [watchedIds] is null or contains an affected key.
|
|
void onWatchStateChanged(WatchStateEvent event);
|
|
|
|
@override
|
|
void initState() {
|
|
super.initState();
|
|
_watchStateSubscription = subscribeToHierarchicalEvents<WatchStateEvent>(
|
|
notifier: WatchStateNotifier(),
|
|
mounted: () => mounted,
|
|
serverId: () => watchStateServerId,
|
|
globalKeys: () => watchedGlobalKeys,
|
|
itemIds: () => watchedIds,
|
|
onEvent: onWatchStateChanged,
|
|
);
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
_watchStateSubscription?.cancel();
|
|
_watchStateSubscription = null;
|
|
super.dispose();
|
|
}
|
|
}
|