FVMClient class

Client for FVM APIs for other apps or packages.

Constructors

FVMClient()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

checkIfGlobal Future<bool> Function(CacheVersion version)
Returns true if cacheVersion is configured as global
final
checkIfGlobalConfigured Future<GlobalConfigured> Function()
Returns true if FVM global version is configured corretly
final
console → ConsoleController
Console controller for streams of process output
final
context → FvmContext
Returns FVM cache directory
final
fetchProjects Future<List<Project>> Function(List<Directory> paths)
Returns a list of projects by providing a list of directories
final
getCachedVersions Future<List<CacheVersion>> Function()
Get all cached Flutter SDK versions
final
getFlutterReleases Future<FlutterReleases> Function({bool cache = true})
Fetches all flutter releases
final
getGlobal Future<CacheVersion?> Function()
Returns async a global configured cache version
final
getGlobalVersionSync String? Function()
Returns sync a global configured cache version
final
getProjectByDirectory Future<Project> Function(Directory directory)
Returns projects by providing a directory
final
readSettings Future<FvmSettings> Function()
Returns FvmSettings
final
saveSettings Future<void> Function(FvmSettings settings)
Saves FVM settings
final
scanDirectory Future<List<Project>> Function({Directory? rootDir})
Scans for Flutter projects found in the rootDir
final
setGlobalVersion Future<void> Function(CacheVersion version)
Sets a version as global
final
upgradeChannel Future<void> Function(CacheVersion version)
Upgrades cached channel version
final

Static Methods

getSdkVersionSync(CacheVersion cacheVersion) String?
Returns the setup sdk version of a versionName
install(String versionName) Future<CacheVersion>
Triggers install workflow for versionName
pinVersion(Project project, String versionName) Future<void>
Triggers use workflow for versionName
remove(String versionName) Future<void>
Triggers remove
setup(String versionName) Future<void>
Triggers finish setup (sdk dependency downloads) for versionName