NEW: Nominations are now open for the 2019 Swift Community Awards! >>

How to support low data mode networking using allowsConstrainedNetworkAccess

Swift version: 5.1

Paul Hudson    @twostraws   

iOS lets users enable Low Data Mode for any cellular or WiFi connection, which signals to apps that they should be careful how much data they use. This might mean downloading lower-resolution images, it might mean disabling prefetching, or some other way of cutting down on bandwidth use.

By default your app does not honor the user’s low data mode setting, but you can change that by setting the allowsConstrainedNetworkAccess property to false for a given URLRequest. For example:

var request = URLRequest(url: someURL)
request.allowsConstrainedNetworkAccess = false

When that request executes iOS will immediately return an error if low data mode is enabled, which might be your cue to do another request for less data or lower-resolution images, for example. You can detect this error by typecasting it to a URLError, then checking if the networkUnavailableReason property is set to .constrained:

if let error = error as? URLError, error.networkUnavailableReason == .constrained {
    // user has activated low data mode so this request could not be satisfied
}

Tip: There is a similarly named URLSession property called allowsExpensiveNetworkAccess, which determines whether network requests can be made over a personal hotspot. It’s considered expensive because often users on cellular networks have lower data caps, but broadly speaking you should prefer working with low data mode because it gives users control.

LEARN SWIFTUI FOR FREE I have a massive, free SwiftUI video collection on YouTube teaching you how to build complete apps with SwiftUI – check it out!

Available from iOS 13.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

MASTER SWIFT NOW
Buy Testing Swift Buy Practical iOS 12 Buy Pro Swift Buy Swift Design Patterns Buy Swift Coding Challenges Buy Server-Side Swift (Vapor Edition) Buy Server-Side Swift (Kitura Edition) Buy Hacking with macOS Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with Swift Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let us know!

Average rating: 5.0/5