Running view-agent by your application

Every time your application is started, it should start view-agent as well. It can do this immediately or after some time. The later the view-agent is started, the later the user of your application will be presented with possible content.

view-agent is started with parameters:

where:

  • channel_id – the ID of the banner channel intended for this application. You can find it in AppVersion.info on the dashboard, at the bottom of the application block. You can rewrite the ID or copy it to the clipboard using the Copy button.
  • channel_id
  • your_app_version – the version of your application. It should grow after each update (or at least after each update of your application for which you have prepared information to display). The classic solution is for your application to read it from a file that is updated when an update is installed.
  • On the user's computer, the banner will be displayed (once) when your_app_version is equal to the version number on the prepared banner:
  • your_app_version
  • mode – normal or force:
    • normalview-agent handles the logic when to display a banner with the given number (it won't be displayed on the first application launch, after an update it will be displayed but only once).
    • force – forcing a banner to be displayed regardless of the underlying logic of our service.

For example, to run the view-agent with the following parameters:

  • channel_id: sAJ2_QeCP
    your_app_version: 1
    mode: FORCE

execute one of the following commands:

windows

Windows

Copy

AppVersionInfo sAJ2_QeCP 1 FORCE

linux

Linux

Copy

./AppVersionInfo.AppImage sAJ2_QeCP 1 FORCE

MacOS

MacOS

Copy

open ./AppVersionInfo.app --args sAJ2_QeCP 1 FORCE