FlutterBuildApkSettings Class

Summary

Settings for flutter build apk. Build an Android APK file from your app..
Assembly
Cake.Flutter.dll
Namespace
Cake.Flutter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Flutter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["FlutterBuildApkSettings"] class Type type-node

Syntax

public sealed class FlutterBuildApkSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
BuildName string
--build-name=<x.y.z> A "x.y.z" string used as the version number shown to users. For each new version of your app, you will provide a version number to differentiate it from previous versions. On Android it is used as 'versionName'. On Xcode builds it is used as 'CFBundleShortVersionString'
BuildNumber Nullable<int>
--build-number=<int> An integer used as an internal version number. Each build must have a unique number to differentiate it from previous builds. It is used to determine whether one build is more recent than another, with higher numbers indicating more recent build. On Android it is used as 'versionCode'. On Xcode builds it is used as 'CFBundleVersion'
BuildSharedLibrary Nullable<bool>
--build-shared-library Whether to prefer compiling to a *.so file (android only).
Debug Nullable<bool>
--debug Build a debug version of your app.
DeviceId string
Target device id or name (prefixes allowed).
Inherited from AutoToolSettings
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.
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 (default mode).
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 [android-arm (default), android-arm64]

Extension Methods

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