ScreenReporter class
A bounded, opt-in diagnostic recorder. No upload happens until the editor's consent action.
- Inheritance
-
- Object
- ChangeNotifier
- ScreenReporter
- Mixed-in types
Constructors
- ScreenReporter(ReporterConfig config, {ReporterDeviceRegistration? registration})
Properties
-
boundaryKey
→ GlobalKey<
State< StatefulWidget> > -
final
- config → ReporterConfig
-
final
- deviceRegistration → ReporterDeviceRegistration
-
latefinal
-
events
→ List<
Map< String, dynamic> > -
no setter
-
frames
→ List<
Map< String, dynamic> > -
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- isActive → bool
-
no setter
- isDeviceApproved → bool
-
no setter
- isPresentingUi → bool
-
no setter
- isRecording → bool
-
no setter
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- screen ↔ String
-
getter/setter pair
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
capture(
) → Future< Uint8List?> -
didChangeAccessibilityFeatures(
) → void -
Called when the system changes the set of currently active accessibility
features.
inherited
-
didChangeAppLifecycleState(
AppLifecycleState state) → void -
Called when the system puts the app in the background or returns
the app to the foreground.
override
-
didChangeLocales(
List< Locale> ? locales) → void -
Called when the system tells the app that the user's locale has
changed. For example, if the user changes the system language
settings.
inherited
-
didChangeMetrics(
) → void -
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness(
) → void -
Called when the platform brightness changes.
inherited
-
didChangeTextScaleFactor(
) → void -
Called when the platform's text scale factor changes.
inherited
-
didChangeViewFocus(
ViewFocusEvent event) → void -
Called whenever the PlatformDispatcher receives a notification that the
focus state on a view has changed.
inherited
-
didHaveMemoryPressure(
) → void -
Called when the system is running low on memory.
inherited
-
didPopRoute(
) → Future< bool> -
Called when the system tells the app to pop the current route, such as
after a system back button press or back gesture.
inherited
-
didPushRoute(
String route) → Future< bool> -
Called when the host tells the application to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(
RouteInformation routeInformation) → Future< bool> -
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didRequestAppExit(
) → Future< AppExitResponse> -
Called when a request is received from the system to exit the application.
inherited
-
dispose(
) → void -
Discards any resources used by the object.
override
-
handleCancelBackGesture(
) → void -
Called when a predictive back gesture is canceled, indicating that no
navigation should occur.
inherited
-
handleCommitBackGesture(
) → void -
Called when a predictive back gesture is finished successfully, indicating
that the current route should be popped.
inherited
-
handleStartBackGesture(
PredictiveBackEvent backEvent) → bool -
Called at the start of a predictive back gesture.
inherited
-
handleStatusBarTap(
) → void -
Called when the user taps the status bar on iOS, to scroll a scroll
view to the top.
inherited
-
handleUpdateBackGestureProgress(
PredictiveBackEvent backEvent) → void -
Called when a predictive back gesture moves.
inherited
-
initialize(
) → Future< void> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
record(
String type, String name, [Map< String, Object?> attributes = const {}]) → void - Attributes must be deliberately selected non-sensitive scalar values.
-
recordAction(
String name, [Map< String, Object?> attributes = const {}]) → String - Returns a correlation ID. Recording still requires explicit consent.
-
recordError(
String code, {String? errorType, String? actionId, String? requestId, Map< String, Object?> attributes = const {}}) → void - Records a safe error code/type, never exception messages or stack contents.
-
recordStateChange(
String name, {required Map< String, Object?> attributes, String? actionId, String? requestId}) → void -
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
requestRecording(
BuildContext context, {bool includeReplay = true, bool includePerformance = false, double frameBudgetMs = 16.67}) → Future< void> -
resetSession(
) → void - Call on logout/account change. Re-enter recording through the consent UI.
-
setActive(
bool active) → Future< void> -
setScreen(
String id, {bool sensitive = false}) → void -
showDeviceRegistration(
) → Future< void> -
showLauncherMenu(
) → Future< void> - Opens at most one reporting menu/flow, including OS screenshot invocation.
-
showReport(
) → Future< void> -
startOperation(
String name, {String? actionId}) → ReporterOperation -
stopRecording(
) → void -
submit(
Map< String, dynamic> payload) → Future<String> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- channel → const MethodChannel