Edit

Configure update settings in the App Installer file

  • Article

As mentioned in App Installer file overview, you can configure the update behavior of the app in the App Installer file. This article explores the update options and their respective trade-offs.

You can configure the update behavior of the app by using the UpdateSettings element. Here we explore the update options and their respective trade-offs.

In short, you can choose to check for updates two different ways:

  1. Independently of the user launching the app.
  2. Only when the user launches the app.

Additionally, you can choose to apply updates in two different ways:

  1. By informing the user with a prompt.
  2. Silently, without informing the user.

Finally, when you inform the user of an update, you can either force them to take the update before allowing them to launch the app, or you can allow them to launch the app and apply the update at an opportune time.

The UpdateSettings element can have the following child elements:

App Installer file update setting Min Windows 10 Version
OnLaunch 1709
HoursBetweenUpdateChecks 1803
AutomaticBackgroundTask 1803
UpdateBlocksActivation 1903
ShowPrompt 1903
ForceUpdateFromAnyVersion 1903

  • OnLaunch: Checks for updates on launch. This type of update can show UI and has the following attributes:

    • HoursBetweenUpdateChecks: An integer that indicates how often (in how many hours) the system will check for updates to the app. “0” to “255” inclusive. The default value is 24 (if this value is not specified). For example if HoursBetweenUpdateChecks = 3 then when the user launches the app, if the system has not checked for updates within the past 3 hours, it will check for updates now.

    • ShowPrompt: A boolean that determines if UI will be shown to the user. This value is supported on Windows 10, version 1903 and later.

    • UpdateBlocksActivation: A boolean that determines if the UI shown to the user allows the user to launch the app without taking the update, or if the user must take the update before launching the app. This attribute can be set to “true” only if ShowPrompt is set to “true”. UpdateBlocksActivation=“true” means the UI the user will see, allows the user to take the update or close the app. UpdateBlocksActivation="false" means the UI the user will see, allows the user to take the update or start the app without updating. In the latter case, the update will be applied silently at an opportune time. This value is supported on Windows 10, version 1903 and later.

      Note

      ShowPrompt needs to be set to true if UpdateBlocksActivation is set to true.

  • AutomaticBackgroundTask: Checks for updates in the background every 8 hours independently of whether the user launched the app. This type of update cannot show UI.

  • ForceUpdateFromAnyVersion: Allows the app to update from version x to version x++ or to downgrade from version x to version x--. Without this element, the app can only move to a higher version.