FlutterScreenshotSettings Class


Settings for flutter screenshot. Take a screenshot from a connected device..
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Flutter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["FlutterScreenshotSettings"] class Type type-node


public sealed class FlutterScreenshotSettings : AutoToolSettings


Type Description



Name Value Summary
DeviceId string
Target device id or name (prefixes allowed).
Inherited from AutoToolSettings
Help Nullable<bool>
-h, --help Print this usage information.
ObservatoryPort Nullable<int>
--observatory-port=<port> The observatory port to connect to. This is required when --type is "skia" or "rasterizer". To find the observatory port number, use "flutter run --verbose" and look for "Forwarded host port ... for Observatory" in the output.
Out DirectoryPath
-o, --out=<path/to/file> Location to write the screenshot.
Packages FilePath
Path to your ".packages" file. (required, since the current directory does not contain a ".packages" file)
Inherited from AutoToolSettings
SuppressAnalytics Nullable<bool>
Suppress analytics reporting when this command runs.
Inherited from AutoToolSettings
Type Nullable<bool>
--type=<type> The type of screenshot to retrieve.

Extension Methods

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