displayName

Declare an instance specific DisplayName to be shown while multiple instances of TorRuntime are in operation. The "previous" and "next" notification action buttons (only shown if more than 1 TorRuntime is in operation) will cycle between instances, showing that instance's current state. This should be different for each of your TorRuntime instances so the user may differentiate between more easily.

NOTE: If this BuilderScope is being configured via the Factory.BuilderScope.defaultConfig DSL, then it will be set back to DisplayName.FID when Factory is instantiated. This can only be configured on a per-instance basis. Use Config.newConfig from Factory.defaultConfig to modify for instance specific configs.

e.g.

// Assuming multiple instances because you are overriding something
// that is only used when multiple runtimes are operating.
val environment = serviceConfig.newEnvironment(
    dirName = "torservice/1",
    instanceConfig = serviceConfig.factory.defaultConfig.newConfig {
        displayName = DisplayName.StringRes(R.string.tor_instance_1)
        // ...
    },
    loader = ResourceLoaderTorExec::getOrCreate,
    block = {
        // Use base directory for all resources for all Environment
        // instances (i.e. torservice)
        resourceDir = workDirectory.parentFile!!

        // ...
    },
)

Default: DisplayName.FID, unless this BuilderScope is a result of Config.newConfig, then whatever Config.displayName is.

See also