Skip to main content

Project index

  • vpkc_app_run — VelopackApp helps you to handle app activation events correctly.

  • vpkc_app_set_args — Override the command line arguments used by VelopackApp. (by default this is env::args().skip(1))

  • vpkc_app_set_auto_apply_on_startup — Set whether to automatically apply downloaded updates on startup. This is ON by default.

  • vpkc_app_set_hook_after_install — WARNING: FastCallback hooks are run during critical stages of Velopack operations.

  • vpkc_app_set_hook_after_update — WARNING: FastCallback hooks are run during critical stages of Velopack operations.

  • vpkc_app_set_hook_before_uninstall — WARNING: FastCallback hooks are run during critical stages of Velopack operations.

  • vpkc_app_set_hook_before_update — WARNING: FastCallback hooks are run during critical stages of Velopack operations.

  • vpkc_app_set_hook_first_run — This hook is triggered when the application is started for the first time after installation.

  • vpkc_app_set_hook_restarted — This hook is triggered when the application is restarted by Velopack after installing updates.

  • vpkc_app_set_locator — VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).

  • vpkc_asset_t — An individual Velopack asset, could refer to an asset on-disk or in a remote package feed.

  • vpkc_check_for_updates — Checks for updates, returning None if there are none available. If there are updates available, this method will return an UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available.

  • vpkc_download_updates — Downloads the specified updates to the local app packages directory. Progress is reported back to the caller via an optional callback.

  • vpkc_free_asset — Frees a vpkc_asset_t instance.

  • vpkc_free_update_info — Frees a vpkc_update_info_t instance.

  • vpkc_free_update_manager — Frees a vpkc_update_manager_t instance.

  • vpkc_get_app_id — Returns the currently installed app id.

  • vpkc_get_current_version — Returns the currently installed version of the app.

  • vpkc_get_last_error — Get the last error message that occurred in the Velopack library.

  • vpkc_hook_callback_t — VelopackApp startup hook callback function.

  • vpkc_is_portable — Returns whether the app is in portable mode. On Windows this can be true or false.

  • vpkc_locator_config_t — VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).

  • vpkc_log_callback_t — Log callback function.

  • vpkc_new_update_manager — Create a new UpdateManager instance.

  • vpkc_progress_callback_t — Progress callback function.

  • vpkc_set_logger — Set a custom log callback. This will be called for all log messages generated by the Velopack library.

  • vpkc_update_check_t — The result of a call to check for updates. This can indicate that an update is available, or that an error occurred.

  • vpkc_update_info_t — Holds information about the current version and pending updates, such as how many there are, and access to release notes.

  • vpkc_update_manager_t — Opaque type for the Velopack UpdateManager. Must be freed with vpkc_free_update_manager.

  • vpkc_update_options_t — Options to customise the behaviour of UpdateManager.

  • vpkc_update_pending_restart — Returns an UpdateInfo object if there is an update downloaded which still needs to be applied.

  • vpkc_wait_exit_then_apply_update — This will launch the Velopack updater and tell it to wait for this program to exit gracefully.