FlutterRunSettings Class

Summary

Settings for flutter run. Run your Flutter app on an attached device..
Assembly
Cake.Flutter.dll
Namespace
Cake.Flutter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Flutter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["FlutterRunSettings"] class Type type-node

Syntax

public sealed class FlutterRunSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Name Summary
FlutterRunSettings()

Properties

Name Value Summary
Build Nullable<bool>
--[no-]build If necessary, build the app before running. (defaults to on)
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
EnableSoftwareRendering Nullable<bool>
--enable-software-rendering Enable rendering using the Skia software backend. This is useful when testing Flutter on emulators. By default, Flutter will attempt to either use OpenGL or Vulkan and fall back to software when neither is available.
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.
Hot Nullable<bool>
--[no-]hot Run with support for hot reloading. (defaults to on)
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
PidFile string
--pid-file Specify a file to write the process id to. You can send SIGUSR1 to trigger a hot reload and SIGUSR2 to trigger a hot restart.
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.
SkiaDeterministicRendering Nullable<bool>
--skia-deterministic-rendering When combined with --enable-software-rendering, provides 100% deterministic Skia rendering.
StartPaused Nullable<bool>
--start-paused Start in a paused mode and wait for a debugger to connect.
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]
TraceSkia Nullable<bool>
--trace-skia Enable tracing of Skia code. This is useful when debugging the GPU thread. By default, Flutter will not log skia code.
TraceStartup Nullable<bool>
--trace-startup Start tracing during startup.
UseTestFonts Nullable<bool>
--[no-]use-test-fonts Enable (and default to) the "Ahem" font. This is a special font used in tests to remove any dependencies on the font metrics. It is enabled when you use "flutter test". Set this flag when running a test using "flutter run" for debugging purposes. This flag is only available when running in debug mode.

Extension Methods

Name Value Summary
Dump<FlutterRunSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<FlutterRunSettings>(FlutterRunSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<FlutterRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<FlutterRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<FlutterRunSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<FlutterRunSettings>(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