runtime-service/io.matthewnelson.kmp.tor.runtime.service/TorServiceConfig/Foreground/BuilderScope

BuilderScope

class BuilderScope : TorServiceConfig.BuilderScope(source)

Extended builder options for TorServiceConfig.Builder, specific to Foreground operations.

Properties

@JvmField

On Android API 24+, if a Foreground Service stops while the task is removed (e.g. user swipes it away from the recent app's tray), the OS does not kill the application process like it would on Android API 23 and below.

stopServiceOnTaskRemoved

@JvmField

var stopServiceOnTaskRemoved: Boolean

If TorService is running and your application is swiped from the recent app's tray (user removes the Task), this setting indicates the behavior of how you wish to react.

testUseBuildDirectory

@ExperimentalKmpTorApi

@JvmField

var testUseBuildDirectory: Boolean

For android unit tests, a setting of true will use the module build directory, instead of the system temp directory, when setting up the environment directories.

useNetworkStateObserver

@JvmField

var useNetworkStateObserver: Boolean

While TorService is running, a NetworkObserver that monitors the device's connectivity state will be used for all instances of TorRuntime operating within the service. If this is set to false, it will not be used and the TorRuntime will be created with whatever was declared for TorRuntime.BuilderScope.networkObserver.