EmbraceNavigationObserver class

A NavigatorObserver that automatically tracks app navigation This class registers in Embrace when a view starts or stops by listening when a route is pushed or popped.

EmbraceNavigationObserver should be added to the navigationObserver of MaterialApp or your main Navigator.

import 'package:flutter/material.dart';
import 'package:embrace/embrace.dart';

MaterialApp(
  navigatorObservers: [
    EmbraceNavigatorObserver(),
  ],
  // ...
)

By default the view name is the same as the route name from its settings, but it can be modified by using a custom name extractor in routeSettingsExtractor

MaterialPageRoute(settings: RouteSettings(name: 'FirstPage'))
Inheritance

Constructors

EmbraceNavigationObserver({EmbraceRouteSettingsExtractor? routeSettingsExtractor, EmbraceScreenLoadConfig screenLoadConfig = const EmbraceScreenLoadConfig()})
A NavigatorObserver that automatically tracks app navigation This class registers in Embrace when a view starts or stops by listening when a route is pushed or popped.

Properties

hashCode → int
The hash code for this object.
no setterinherited
The navigator that the observer is observing, if any.
no setterinherited
routeSettingsExtractor → EmbraceRouteSettingsExtractor?
A function that returns the settings from a given route
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenLoadConfig → EmbraceScreenLoadConfig
Configuration for the screen-load span timing.
final

Methods

debugObservingRoute(ModalRoute route) → bool
Whether this observer is managing changes for the specified route.
inherited
didChangeTop(Route topRoute, Route? previousTopRoute) → void
The top most route has changed.
inherited
didPop(Route route, Route? previousRoute) → void
The Navigator popped route.
override
didPush(Route route, Route? previousRoute) → void
The Navigator pushed route.
override
didRemove(Route route, Route? previousRoute) → void
The Navigator removed route.
inherited
didReplace({Route? newRoute, Route? oldRoute}) → void
The Navigator replaced oldRoute with newRoute.
override
didStartUserGesture(Route route, Route? previousRoute) → void
The Navigator's routes are being moved by a user gesture.
inherited
didStopUserGesture() → void
User gesture is no longer controlling the Navigator.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
subscribe(RouteAware routeAware, ModalRoute route) → void
Subscribe routeAware to be informed about changes to route.
inherited
toString() → String
A string representation of this object.
inherited
unsubscribe(RouteAware routeAware) → void
Unsubscribe routeAware.
inherited

Operators

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

Static Methods

resetTtiSpanForTesting() → void
Resets the one-shot TTI span state. Intended for use in test tearDown.