RumUserActionDetector class

Detect simple user actions and send them to RUM.

This wrapper widget automatically detects tap user actions that occur in its tree and sends them to RUM. It detects interactions with several common Flutter widgets, including ElevatedButton, TextButton, CupertinoButton, FloatingActionButton, BottomNavigationBar, TabBar, InkWell, and GestureDetector. You can also provide a custom detection logic by passing customGestureDetector parameter to detect your custom tappable widgets. Example:

customGestureDetector: (widget) {
   if (widget is CustomButton) {
     return RumGestureDetectorInfo('CustomButton');
   }
   return null;
}

For buttons that provide a tooltip, like IconButton.tooltip and FloatingActionButton.tooltip, the detector will use the tooltip as the description of the action. For most other Button types, the detector will look for a Text widget child, which it will use for the description of the action. In other cases, it will look for a child Semantics object, or an Icon with its Icon.semanticsLabel property set. If none of these provide a description, the detector falls back to the message of a Tooltip enclosing the tapped widget.

Alternately, you can enclose any Widget tree with a RumUserActionAnnotation, which will use the provided description when reporting user actions detected in the child tree, without changing the Semantics of the tree.

Inheritance

Constructors

RumUserActionDetector({Key? key, required DatadogRum? rum, required Widget child, CustomGestureElementDetector? customGestureDetector})
const

Properties

child → Widget
The Widget tree to detect gestures in.
final
customGestureDetector → CustomGestureElementDetector?
A function that provides custom gesture detection logic.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
rum → DatadogRum?
The instance of RUM to report to.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
override
createState() → State<RumUserActionDetector>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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