SignboxVpn class
Constructors
- SignboxVpn({SignboxVpnPlatform? platform, SingboxConfigBuilder configBuilder = const SingboxConfigBuilder(), VpnConfigParser configParser = const VpnConfigParser(), VpnSubscriptionParser subscriptionParser = const VpnSubscriptionParser()})
Properties
- activeEndpointProfile → VpnProfile?
-
no setter
- activeProfile → VpnProfile?
-
no setter
-
endpointHealth
→ List<
VpnEndpointHealth> -
no setter
-
endpointPool
→ List<
VpnProfile> -
no setter
- featureSettings → SingboxFeatureSettings
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stateDetailsStream
→ Stream<
VpnConnectionSnapshot> -
no setter
-
stateStream
→ Stream<
VpnConnectionState> -
no setter
-
statsStream
→ Stream<
VpnRuntimeStats> -
no setter
Methods
-
applyConfigDocument(
SingboxConfigDocument document) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
applyConfigLink(
{required String configLink, String? fallbackTag, String? sbmmPassphrase, BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings}) → Future< Map< String, Object?> > -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
applyEndpointPool(
{required List< VpnProfile> profiles, EndpointPoolOptions options = const EndpointPoolOptions(), BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings}) → Future<Map< String, Object?> > -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
applyProfile(
{required VpnProfile profile, BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings, bool clearEndpointPool = true}) → Future< Map< String, Object?> > -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
connectAutoSubscription(
{required String rawSubscription, String source = 'inline', bool tryBase64Decode = true, bool deduplicate = true, String? sbmmPassphrase, EndpointPoolOptions options = const EndpointPoolOptions(), BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings, bool requestPermission = true, bool preferLowestLatency = true, Duration pingTimeout = const Duration(seconds: 3)}) → Future< AutoConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnSubscriptionApi extension
-
connectAutoWithPreset(
{required String rawSubscription, GfwPresetPack? preset, String source = 'inline', bool tryBase64Decode = true, bool deduplicate = true, String? sbmmPassphrase, bool requestPermission = true, bool preferLowestLatency = true, Duration pingTimeout = const Duration(seconds: 3)}) → Future< AutoConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnSubscriptionApi extension
-
connectManualConfigLink(
{required String configLink, String? fallbackTag, String? sbmmPassphrase, BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings, bool requestPermission = true}) → Future< ManualConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnManualConnectApi extension
-
connectManualConfigLinkWithPreset(
{required String configLink, String? fallbackTag, String? sbmmPassphrase, GfwPresetPack? preset, bool requestPermission = true}) → Future< ManualConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnManualConnectApi extension
-
connectManualProfile(
{required VpnProfile profile, BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings, bool requestPermission = true}) → Future< ManualConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnManualConnectApi extension
-
connectManualWithPreset(
{required VpnProfile profile, GfwPresetPack? preset, bool requestPermission = true}) → Future< ManualConnectResult> -
Available on SignboxVpn, provided by the SignboxVpnManualConnectApi extension
-
dispose(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnLifecycleApi extension
-
extractConfigEndpoints(
String configJson) → List< SingboxEndpointSummary> -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
extractConfigLinkSummary(
String configLink, {String? fallbackTag, String? sbmmPassphrase}) → VpnProfileSummary -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
extractSubscriptionSummaries(
String rawSubscription, {String source = 'inline', bool tryBase64Decode = true, bool deduplicate = true, String? sbmmPassphrase}) → List< VpnProfileSummary> -
Available on SignboxVpn, provided by the SignboxVpnSubscriptionApi extension
-
filterProfilesByCoreSupport(
{required List< VpnProfile> profiles, bool refresh = false}) → Future<List< VpnProfile> > -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getCoreCapabilities(
{bool refresh = false}) → Future< VpnCoreCapabilities> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getLastError(
) → Future< String?> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getSingboxVersion(
) → Future< String?> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getState(
) → Future< VpnConnectionState> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getStateDetails(
) → Future< VpnConnectionSnapshot> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
getStats(
) → Future< VpnRuntimeStats> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
importSubscription(
{required String rawSubscription, String source = 'inline', bool tryBase64Decode = true, bool deduplicate = true, String? sbmmPassphrase, bool connect = false, EndpointPoolOptions options = const EndpointPoolOptions(), BypassPolicy bypassPolicy = const BypassPolicy(), TrafficThrottlePolicy throttlePolicy = const TrafficThrottlePolicy(), SingboxFeatureSettings? featureSettings}) → Future< SubscriptionImportResult> -
Available on SignboxVpn, provided by the SignboxVpnSubscriptionApi extension
-
initialize(
SingboxRuntimeOptions options) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnLifecycleApi extension
-
isProtocolSupportedByCore(
VpnProtocol protocol, {bool refresh = false}) → Future< bool> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
listGfwPresetPacks(
) → List< GfwPresetPack> -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
parseConfigDocument(
String configJson) → SingboxConfigDocument -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
parseConfigLink(
String configLink, {String? fallbackTag, String? sbmmPassphrase}) → ParsedVpnConfig -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
parseSubscription(
String rawSubscription, {String source = 'inline', bool tryBase64Decode = true, bool deduplicate = true, String? sbmmPassphrase}) → ParsedVpnSubscription -
Available on SignboxVpn, provided by the SignboxVpnSubscriptionApi extension
-
pingEndpointPool(
{Duration timeout = const Duration(seconds: 3), bool updateHealth = true, String? connectivityProbeUrl, Duration? connectivityProbeTimeout, Map< String, String> connectivityProbeHeaders = const <String, String>{}}) → Future<List< VpnPingResult> > -
Available on SignboxVpn, provided by the SignboxVpnDiagnosticsApi extension
-
pingProfile(
{required VpnProfile profile, Duration timeout = const Duration(seconds: 3), String? connectivityProbeUrl, Duration? connectivityProbeTimeout, Map< String, String> connectivityProbeHeaders = const <String, String>{}, bool allowConnectivityProbeFallback = true}) → Future<VpnPingResult> -
Available on SignboxVpn, provided by the SignboxVpnDiagnosticsApi extension
-
probeConnectivity(
{String? url, Duration timeout = const Duration(seconds: 8), Map< String, String> headers = const <String, String>{}}) → Future<VpnConnectivityProbe> -
Available on SignboxVpn, provided by the SignboxVpnDiagnosticsApi extension
-
requestNotificationPermission(
) → Future< bool> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
requestVpnPermission(
) → Future< bool> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
resetProfile(
{bool stopVpn = true}) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnLifecycleApi extension
-
restart(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
rotateEndpoint(
{bool reconnect = true}) → Future< VpnProfile?> -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
runDiagnostics(
{bool strictTls = false, bool includeEndpointPoolPing = true, bool includeConnectivityProbe = true, Duration pingTimeout = const Duration(seconds: 3), Duration connectivityTimeout = const Duration(seconds: 8)}) → Future< VpnDiagnosticsReport> -
Available on SignboxVpn, provided by the SignboxVpnDiagnosticsApi extension
-
selectBestEndpointByPing(
{Duration timeout = const Duration(seconds: 3), bool reconnect = false}) → Future< VpnProfile?> -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
selectEndpoint(
{required int index, bool reconnect = true}) → Future< VpnProfile?> -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
setFeatureSettings(
SingboxFeatureSettings settings) → void -
Available on SignboxVpn, provided by the SignboxVpnLifecycleApi extension
-
setRawConfig(
Map< String, Object?> config) → Future<void> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
start(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
startManaged(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnEndpointApi extension
-
stop(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
summarizeProfile(
VpnProfile profile, {int index = 0, List< String> warnings = const <String>[]}) → VpnProfileSummary -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
syncRuntimeState(
) → Future< void> -
Available on SignboxVpn, provided by the SignboxVpnRuntimeApi extension
-
toString(
) → String -
A string representation of this object.
inherited
-
unwrapSecureConfigLink(
{required String sbmmLink, required String passphrase}) → String -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
-
validateProfile(
VpnProfile profile, {bool strictTls = false}) → List< VpnDiagnosticIssue> -
Available on SignboxVpn, provided by the SignboxVpnDiagnosticsApi extension
-
wrapSecureConfigLink(
{required String configLink, required String passphrase, int pbkdf2Iterations = SbmmSecureLinkCodec.defaultPbkdf2Iterations}) → String -
Available on SignboxVpn, provided by the SignboxVpnConfigApi extension
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited