Checks the update manifest and optionally stages and installs a plugin update.
Fetches the signed update manifest and reports the latest release, beta, and nightly versions along with the download URL for the target platform and whether a newer version is available. When ApplyUpdate is set, it downloads and stages the matching build for installation. All arguments are optional.
Declaration
Inlay_SELF_UPDATE ( JSONSetElement ( "{}" ;
[ "Channel" ; "beta" ; JSONString ] ;
[ "ApplyUpdate" ; False ; JSONBoolean ]
) )Parameters
- Channel Optional
- release, beta, or nightly. Default release.
- RequestedVersion Optional
- an exact version, or latest or blank for the newest on the channel.
- Platform Optional
- auto, macos, or windows. Default auto, which resolves to the current OS.
- ApplyUpdate Optional
- 1/true/yes or 0/false/no. When true, the resolved build is staged and installed instead of only reported.
- CurrentVersionOverride Optional
- a version string used in place of the running version for update_available comparison. Mainly for testing.
Returns
JSON string On success returns a JSON object with per-channel payloads carrying current_version, the channel's latest version, update_available, available versions, and platform download URLs. When ApplyUpdate is true it also reports the staged install outcome. On failure returns {"ok":false,"message":"..."}.
Use Cases
- Show an "update available" badge by reading update_available on a startup check.
- Trigger a staged install by calling with ApplyUpdate true once the user opts in.
Notes
- Applying an update is not supported on every platform; an unsupported target returns an error message.
- Legacy lowercase keys currentVersionOverride, channel, requestedVersion, platform, applyUpdate are accepted for one release cycle.