FlutterCreateSettings Class

Summary

Settings for flutter create. Create a new Flutter 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["FlutterCreateSettings"] class Type type-node

Syntax

public sealed class FlutterCreateSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
AndroidLanguage Nullable<AndroidLanguage>
-a, --android-language [java (default), kotlin]
Description string
--description The description to use for your new Flutter project. This string ends up in the pubspec.yaml file. (defaults to "A new Flutter project.")
DeviceId string
Target device id or name (prefixes allowed).
Inherited from AutoToolSettings
Help Nullable<bool>
-h, --help Print this usage information.
IosLanguage Nullable<IOSLanguage>
-i, --ios-language [objc (default), swift]
Offline Nullable<bool>
--[no-]offline When "flutter packages get" is run by the create command, this indicates whether to run it in offline mode or not. In offline mode, it will need to have all dependencies already available in the pub cache to succeed.
Org string
--org The organization responsible for your new Flutter project, in reverse domain name notation. This string is used in Java package names and as prefix in the iOS bundle identifier. (defaults to "com.example")
Overwrite Nullable<bool>
--[no-]overwrite When performing operations, overwrite existing files.
Packages FilePath
Path to your ".packages" file. (required, since the current directory does not contain a ".packages" file)
Inherited from AutoToolSettings
ProjectName string
--project-name The project name for this new Flutter project. This must be a valid dart package name.
Pub Nullable<bool>
--[no-]pub Whether to run "flutter packages get" after the project has been created. (defaults to on)
Sample string
-s, --sample=<the sample ID of the desired sample from the API documentation website (http://docs.flutter.io)> Specifies the Flutter code sample to use as the main.dart for an application. Implies --template=app.
SuppressAnalytics Nullable<bool>
Suppress analytics reporting when this command runs.
Inherited from AutoToolSettings
Template Nullable<Template>
-t, --template=<type> Specify the type of project to create.
WithDriverTest Nullable<bool>
--[no-]with-driver-test Also add a flutter_driver dependency and generate a sample 'flutter drive' test.

Extension Methods

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