SDK 4.0
The protected model: what SDK 4.0 changes, which platforms have it first, and where to start.
SDK 4.0 keeps the API of 3.x: the same Client, model, listen and read on every platform. What changes is underneath. The model is protected. It is encrypted from Quran Lab's server to the device, and only the Quran Lab Core, a closed library inside the SDK, can open it, in its own memory, under a lease that Quran Lab gives each install. No model file is ever written to the device in plain form.
For most apps the update is the new version and one option fewer. What changes from 3.x has the details for each platform.
The model's licence (NPL-1.2) does not allow extracting, decrypting, converting or reverse engineering the model or the Core. The SDK is the supported way to use the model.
Platforms
| Platform | SDK 4.0 | Quick start |
|---|---|---|
| Web | In the first release | Web |
| Android | In the first release | Android |
| Windows and Linux | In the first release | Windows and Linux |
| iOS and macOS | In the first release | Apple |
| Flutter | In the first release: the plugin on pub.dev | Flutter |
What to read
- What changes from 3.x: when to move, the model, offline use, analytics, errors and sharing, platform by platform.
- Offline use and the lease: how long an app runs without a connection, and what happens when Quran Lab cannot be reached.
- Errors in 4.0: the codes an app gets, and the report every failure sends.
- The Problems page: what your app's Problems tab shows, and why.
Apps on 3.x
Quran Lab serves apps on 3.x as before until SDK 3.x stops receiving the V4 model, on 15 January 2027, 00:00 UTC. New model versions, from V4.1 on, ship only encrypted, for SDK 4.0. When an app has to move to 4.0, its page under Apps says so and gives you a prompt for your coding assistant that does the update.