RelevantRegions
class RelevantRegions(val radius: Distance = DEFAULT_RADIUS, val updateInterval: Duration = DEFAULT_UPDATE_INTERVAL, val networkConnectivity: NetworkConnectivityConfiguration = DEFAULT_NETWORK_CONNECTIVITY)
Configuration for relevant regions updates.
Important: This is a Public Preview API. It may be changed or removed at any time.
Constructors
Link copied to clipboard
constructor(radius: Distance = DEFAULT_RADIUS, updateInterval: Duration = DEFAULT_UPDATE_INTERVAL, networkConnectivity: NetworkConnectivityConfiguration = DEFAULT_NETWORK_CONNECTIVITY)
Types
Link copied to clipboard
object Companion
Represents default values for RelevantRegions constructor.
Properties
Link copied to clipboard
Specifies over which network types are downloads allowed. Defaults to always allowing all network types.
Link copied to clipboard
Indicates the distance within which regions around the current position would be considered for an update. This should not be a negative value. Defaults to DEFAULT_RADIUS
Link copied to clipboard
Indicates the time interval when relevant regions will be updated. This should not be a negative value. A value of 0, means periodic updates are disabled. Defaults to DEFAULT_UPDATE_INTERVAL
Functions
Link copied to clipboard
fun copy(radius: Distance = this.radius, updateInterval: Duration = this.updateInterval, networkConnectivity: NetworkConnectivityConfiguration = this.networkConnectivity): AutomaticNdsStoreUpdaterConfiguration.RelevantRegions
Returns a copy calling the RelevantRegions object with possibilities to override every property.