• Home
• Felgo
• VersionCheckLoader

VersionCheckLoader

Provides a convenient way to check if an updated version of your app is available. More...

• List of all members, including inherited members

Properties

• active : bool
• source : string

Detailed Description

You can use this utility to check against a web server whether a newer version of your application is available.

This utility loads a QML source file specified by the source property. This file contains the actual version check logic and any UI that is displayed to the user in the case when a newer version is available. You can use the VersionCheckDialog convenience component to help with this task or use custom QML code to perform the version check and display a message to the user.

You can add the VersionCheckLoader item as a direct child of the root App item. The z property is set to 1 by default in order to place the version notification UI on top of other UI components.

Example Usage

Following example demonstrates the usage of the VersionCheckLoader and VersionCheckDialog components:

Place the following code in your application Main.qml file:

 import Felgo
 import QtQuick

 App {
   id: app

   AppPage {
     // ... UI items go here ...
   }

   // Place the VersionCheckLoader item as the direct descendant of the App item
   // and set the 'source' property accordingly.
   VersionCheckLoader {
     source: "https://mydomain.com/myAppVersionCheck.qml"
   }
 }

Place the following code in myAppVersionCheck.qml file.

Specify the version codes accordingly. You can specify different version codes for each platform as your release cycle might differ between platforms. In similar fashion, for each platform specify URL links where the user can obtain the new version. This can be a link to the application app store page.

 import Felgo
 import QtQuick

 VersionCheckDialog {
   latestVersionCodeIOS: 114
   latestVersionCodeAndroid: 116

   updateUrlIOS: "https://itunes.apple.com/at/app/id1157319191"
   updateUrlAndroid: "https://play.google.com/store/apps/details?id=net.vplay.apps.QMLLive"

   dialogTitle: qsTr("Update Available")
   dialogText: qsTr("A new version is out! Update now?")
 }

In case a newer version is available, the VersionCheckDialog shows the following message. If the user clicks 'OK', they will be taken to the specified URL.

The version check is performed and the dialog is shown as soon as the remote QML file is loaded.

Alternatively, you can use your own custom QML code instead of the VersionCheckDialog component and display any custom UI and perform any custom logic. Within your custom code, you can access the current version of the installed application using the system.appVersionCode context property and the platform using the system.platform context property.

See also VersionCheckDialog.

Property Documentation