FlutterDriver class

Drives a Flutter Application running in another process.

Constructors

FlutterDriver.connectedTo(VMServiceClient _serviceClient, Peer _peer, VMIsolate _appIsolate, { bool printCommunication: false, bool logCommunicationToFile: true, double timeoutMultiplier: _kDefaultTimeoutMultiplier })
Creates a driver that uses a connection provided by the given _serviceClient, _peer and _appIsolate.

Properties

timeoutMultiplier → double
FlutterDriver multiplies all command timeouts by this number. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

checkHealth({Duration timeout }) → Future<Health>
Checks the status of the Flutter Driver extension.
clearTimeline({Duration timeout }) → Future<void>
Clears all timeline events recorded up until now.
close() → Future<void>
Closes the underlying connection to the VM service. [...]
enterText(String text, { Duration timeout }) → Future<void>
Enters text into the currently focused text input, such as the EditableText widget. [...]
forceGC() → Future<void>
Force a garbage collection run in the VM.
getRenderTree({Duration timeout }) → Future<RenderTree>
Returns a dump of the render tree.
getSemanticsId(SerializableFinder finder, { Duration timeout }) → Future<int>
Retrieves the semantics node id for the object returned by finder, or the nearest ancestor with a semantics node. [...]
getText(SerializableFinder finder, { Duration timeout }) → Future<String>
Returns the text in the Text widget located by finder.
getVmFlags({Duration timeout }) → Future<List<Map<String, dynamic>>>
Returns the Flags set in the Dart VM as JSON. [...]
requestData(String message, { Duration timeout }) → Future<String>
Sends a string and returns a string. [...]
runUnsynchronized<T>(Future<T> action(), { Duration timeout }) → Future<T>
action will be executed with the frame sync mechanism disabled. [...]
screenshot({Duration timeout }) → Future<List<int>>
Take a screenshot. The image will be returned as a PNG.
scroll(SerializableFinder finder, double dx, double dy, Duration duration, { int frequency: 60, Duration timeout }) → Future<void>
Tell the driver to perform a scrolling action. [...]
scrollIntoView(SerializableFinder finder, { double alignment: 0.0, Duration timeout }) → Future<void>
Scrolls the Scrollable ancestor of the widget located by finder until the widget is completely visible. [...]
scrollUntilVisible(SerializableFinder scrollable, SerializableFinder item, { double alignment: 0.0, double dxScroll: 0.0, double dyScroll: 0.0, Duration timeout: const Duration(seconds: 10) }) → Future<void>
Repeatedly scroll the widget located by scrollable by dxScroll and dyScroll until item is visible, and then use scrollIntoView to ensure the item's final position matches alignment. [...]
setSemantics(bool enabled, { Duration timeout }) → Future<bool>
Turns semantics on or off in the Flutter app under test. [...]
setTextEntryEmulation({bool enabled, Duration timeout }) → Future<void>
Configures text entry emulation. [...]
startTracing({List<TimelineStream> streams: _defaultStreams, Duration timeout }) → Future<void>
Starts recording performance traces.
stopTracingAndDownloadTimeline({Duration timeout }) → Future<Timeline>
Stops recording performance traces and downloads the timeline.
tap(SerializableFinder finder, { Duration timeout }) → Future<void>
Taps at the center of the widget located by finder.
traceAction(Future action(), { List<TimelineStream> streams: _defaultStreams, bool retainPriorEvents: false }) → Future<Timeline>
Runs action and outputs a performance trace for it. [...]
waitFor(SerializableFinder finder, { Duration timeout }) → Future<void>
Waits until finder locates the target.
waitForAbsent(SerializableFinder finder, { Duration timeout }) → Future<void>
Waits until finder can no longer locate the target.
waitUntilNoTransientCallbacks({Duration timeout }) → Future<void>
Waits until there are no more transient callbacks in the queue. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited

Static Methods

connect({String dartVmServiceUrl, bool printCommunication: false, bool logCommunicationToFile: true, double timeoutMultiplier: _kDefaultTimeoutMultiplier, int isolateNumber, Duration isolateReadyTimeout, Pattern fuchsiaModuleTarget }) → Future<FlutterDriver>
Connects to a Flutter application. [...]