QuickAccessOptions class

A native VPN toggle: Android tile, desktop menu/tray, or Apple control.

Disabled by default. Apple Control Center needs a host Widget extension. Desktop menu/tray controls require the application process to remain alive.

Constructors

QuickAccessOptions({bool enabled = false, QuickAccessSurface surface = QuickAccessSurface.platformDefault, String label = 'VPN', VlessSystemAction action = VlessSystemAction.toggle, bool requireUnlock = true, String androidIconResourceName = 'flutter_vless_ic_quick_tile', String appleSymbol = 'network', String? windowsIconPath})
Creates disabled-by-default quick access; native support is capability-gated.
const

Properties

action → VlessSystemAction
Action performed by the control; defaults to toggling the saved VPN.
final
androidIconResourceName → String
Android drawable name for the tile; excludes a path or file extension.
final
appleSymbol → String
Nonempty SF Symbols name, at most 128 UTF-16 code units; defaults to network.
final
enabled → bool
Whether native quick access is authorized; defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
label → String
Nonempty control label, at most 80 UTF-16 code units; defaults to VPN.
final
requireUnlock → bool
Require Android unlock or Apple local authentication before the action.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
surface → QuickAccessSurface
Requested control surface; unsupported explicit choices fail initialization.
final
windowsIconPath → String?
Optional absolute path to a Windows .ico image. Null uses the app icon.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, Object?>
Encodes this section without storing a VPN configuration or credentials.
toString() → String
A string representation of this object.
inherited

Operators

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