core/commands/simulator/simulator.g library

Constants

validContentSizes → const Set<String>
Valid content size values accepted by xcrun simctl ui <device> content_size.

Functions

clearSimLocation(SimLocationClearInput input) → Future<SimLocationResult>
Stops location simulation on the iOS simulator.
clearSimStatusBar(SimStatusBarClearInput input) → Future<SimStatusBarResult>
Clears all status bar overrides on the iOS simulator.
deleteSimDefaults(SimDefaultsDeleteInput input) → Future<SimDefaultsResult>
Deletes an NSUserDefaults key for a given bundle ID on the iOS simulator.
findSimulator(List<SimulatorDevice> simulators, String udid) → SimulatorDevice?
Returns the simulator in simulators whose UDID matches udid (case-insensitive), or null.
listSimulators() → Future<SimulatorListing>
Lists every simulator known to simctl via simctl list devices -j.
overrideSimStatusBar(SimStatusBarOverrideInput input) → Future<SimStatusBarResult>
Overrides the iOS simulator status bar with the given values.
pickSimulatorDevice(List<SimulatorDevice> simulators, {required String? deviceOverride, required String? sessionDevice}) → SimulatorDeviceResolution
Applies the precedence of resolveSimulatorDevice to an already fetched simulators list, so callers that need the list themselves (for example to decide whether a device ID is a simulator at all) list devices only once.
readSimDefaults(SimDefaultsReadInput input) → Future<SimDefaultsResult>
Reads NSUserDefaults for a given bundle ID on the iOS simulator.
resolveSimulatorDevice({String? deviceOverride}) → Future<SimulatorDeviceResolution>
Resolves the iOS simulator UDID that xcrun simctl commands should target.
runSimctl(List<String> args) → Future<String?>
Runs xcrun simctl with the given args and returns the result.
runSimctlWithOutput(List<String> args) → Future<({String? error, String? stdout})>
Runs xcrun simctl and returns (stdout, error).
runSimLocationRoute(SimLocationRouteInput input) → Future<SimLocationResult>
Starts a built-in location scenario (e.g. "City Run", "Freeway Drive").
sendSimPush(SimPushInput input) → Future<SimPushResult>
Sends a simulated push notification to the iOS simulator.
setSimAppearance(SimAppearanceInput input) → Future<SimAppearanceResult>
Sets or queries the iOS simulator appearance (dark/light mode).
setSimLocation(SimLocationSetInput input) → Future<SimLocationResult>
Sets a static GPS location on the iOS simulator.
setSimTextSize(SimTextSizeInput input) → Future<SimTextSizeResult>
Sets or queries the Dynamic Type content size on the iOS simulator.
writeSimDefaults(SimDefaultsWriteInput input) → Future<SimDefaultsResult>
Writes an NSUserDefaults value for a given bundle ID on the iOS simulator.

Typedefs

SimAppearanceInput = ({String? deviceOverride, String mode})
SimDefaultsDeleteInput = ({String bundleId, String? deviceOverride, String key})
SimDefaultsReadInput = ({String bundleId, String? deviceOverride, String? key})
SimDefaultsWriteInput = ({String bundleId, String? deviceOverride, String key, String type, String value})
SimLocationClearInput = ({String? deviceOverride})
SimLocationRouteInput = ({String? deviceOverride, String scenario})
SimLocationSetInput = ({String? deviceOverride, String latitude, String longitude})
SimPushInput = ({String? bundleId, String? deviceOverride, String payload})
SimStatusBarClearInput = ({String? deviceOverride})
SimStatusBarOverrideInput = ({int? batteryLevel, String? batteryState, int? cellularBars, String? cellularMode, String? dataNetwork, String? deviceOverride, String? operatorName, String? time, int? wifiBars, String? wifiMode})
SimTextSizeInput = ({String? deviceOverride, String size})
SimulatorDevice = ({String name, String runtime, String state, String udid})
One simulator from xcrun simctl list devices -j.
SimulatorDeviceResolution = ({String? error, String? udid})
Outcome of resolveSimulatorDevice: exactly one of udid or error is set.
SimulatorListing = ({String? error, List<SimulatorDevice>? simulators})
Outcome of listSimulators: exactly one of simulators or error is set.