FlutterDriveSettings Class

Summary

Settings for flutter drive. Runs Flutter Driver tests for the current project..
Assembly
Cake.Flutter.dll
Namespace
Cake.Flutter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Flutter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["FlutterDriveSettings"] class Type type-node

Syntax

public sealed class FlutterDriveSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Name Summary
FlutterDriveSettings()

Properties

Name Value Summary
Debug Nullable<bool>
--debug Build a debug version of your app (default mode).
DeviceId string
Target device id or name (prefixes allowed).
Inherited from AutoToolSettings
Driver FilePath
--driver=<path> The test file to run on the host (as opposed to the target file to run on the device). By default, this file has the same base name as the target file, but in the "test_driver/" directory instead, and with "_test" inserted just before the extension, so e.g. if the target is "lib/main.dart", the driver will be "test_driver/main_test.dart".
Flavor string
--flavor Build a custom app flavor as defined by platform-specific build setup. Supports the use of product flavors in Android Gradle scripts. Supports the use of custom Xcode schemes.
Help Nullable<bool>
-h, --help Print this usage information.
KeepAppRunning Nullable<bool>
--[no-]keep-app-running Will keep the Flutter application running when done testing. By default, "flutter drive" stops the application after tests are finished, and --keep-app-running overrides this. On the other hand, if --use-existing-app is specified, then "flutter drive" instead defaults to leaving the application running, and --no-keep-app-running overrides it.
ObservatoryPort Nullable<int>
--observatory-port Listen to the given port for an observatory debugger connection. Specifying port 0 (the default) will find a random free port.
Packages FilePath
Path to your ".packages" file. (required, since the current directory does not contain a ".packages" file)
Inherited from AutoToolSettings
Profile Nullable<bool>
--profile Build a version of your app specialized for performance profiling.
Pub Nullable<bool>
--[no-]pub Whether to run "flutter packages get" before executing this command. (defaults to on)
Release Nullable<bool>
--release Build a release version of your app.
Route string
--route Which route to load when running the app.
SuppressAnalytics Nullable<bool>
Suppress analytics reporting when this command runs.
Inherited from AutoToolSettings
Target FilePath
-t, --target=<path> The main entry-point file of the application, as run on the device. If the --target option is omitted, but a file name is provided on the command line, then that is used instead. (defaults to "lib/main.dart")
TargetPlatform Nullable<TargetPlatform>
--target-platform Specify the target platform when building the app for an Android device. Ignored on iOS. [default (default), android-arm, android-arm64]
TraceStartup Nullable<bool>
--trace-startup Start tracing during startup.
UseExistingApp string
--use-existing-app=<url> Connect to an already running instance via the given observatory URL. If this option is given, the application will not be automatically started, and it will only be stopped if --no-keep-app-running is explicitly set.

Extension Methods

Name Value Summary
Dump<FlutterDriveSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<FlutterDriveSettings>(FlutterDriveSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<FlutterDriveSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<FlutterDriveSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<FlutterDriveSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<FlutterDriveSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin