Stay organized with collections
Save and categorize content based on your preferences.
UAppUpdateInfo
#include <AppUpdateInfo.h>
This class represents the information about the app update.
Summary
Inheritance
Inherits from: UObject
Public functions
BeginDestroy
virtual void BeginDestroy() override
Part of UObject interface.
Called when the object is marked for deletion by MarkPendingKill.
ClearAppUpdateInfo
void ClearAppUpdateInfo()
Clears the native app update info object.
GetAvailableVersionCode
int32 GetAvailableVersionCode()
Returns the available version code of the app update.
GetBytesDownloaded
int64 GetBytesDownloaded()
Returns the number of bytes downloaded so far.
GetClientVersionStalenessDays
int32 GetClientVersionStalenessDays()
Returns the number of days since the client version was last updated.
GetPriority
int32 GetPriority()
Returns the priority of the app update.
GetTotalBytesToDownload
int64 GetTotalBytesToDownload()
Returns the total number of bytes to download.
IsUpdateTypeAllowed
bool IsUpdateTypeAllowed(
UAppUpdateOptions *InAppUpdateOptions
)
Returns whether the update type is allowed.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[],[],null,["# UAppUpdateInfo Class Reference\n\nUAppUpdateInfo\n==============\n\n\n`#include \u003cAppUpdateInfo.h\u003e`\n\nThis class represents the information about the app update.\n\nSummary\n-------\n\n### Inheritance\n\nInherits from: UObject\n\n| ### Public functions ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [BeginDestroy](#class_u_app_update_info_1ac33cbe71174ce0c1a3e2accb36d53898)`() override` | `virtual void` Part of UObject interface. |\n| [ClearAppUpdateInfo](#class_u_app_update_info_1a45af9beec6c879c965ef27216ba79bf6)`()` | `void` Clears the native app update info object. |\n| [GetAvailability](#class_u_app_update_info_1a644c4a22d613e6224661dca6cf765c54)`()` | [EAppUpdateAvailability](/reference/unreal-engine/play/core/group/play-in-app-updates#group___play_in_app_updates_1ga3b474c632ea8ed9f0b94b7970a3e088b) Returns the availability of the app update. |\n| [GetAvailableVersionCode](#class_u_app_update_info_1af71717047a00e956bbed381a6421daa5)`()` | `int32` Returns the available version code of the app update. |\n| [GetBytesDownloaded](#class_u_app_update_info_1abd937b7a739396d2f3b966cae0817e7b)`()` | `int64` Returns the number of bytes downloaded so far. |\n| [GetClientVersionStalenessDays](#class_u_app_update_info_1aa9c11c25d6e161828f53ecc0b2333ebb)`()` | `int32` Returns the number of days since the client version was last updated. |\n| [GetPriority](#class_u_app_update_info_1aa7ae8fdaf312a5711c98fb5bdd5dcfe6)`()` | `int32` Returns the priority of the app update. |\n| [GetStatus](#class_u_app_update_info_1a4fc60cb7b360093b0608e5fcd65294cb)`()` | [EAppUpdateStatus](/reference/unreal-engine/play/core/group/play-in-app-updates#group___play_in_app_updates_1gac7a80bab2855a9da66be9657e94c5ba0) Returns the status of the app update. |\n| [GetTotalBytesToDownload](#class_u_app_update_info_1a40b50d4af11e28c121b0874b11c85479)`()` | `int64` Returns the total number of bytes to download. |\n| [IsUpdateTypeAllowed](#class_u_app_update_info_1a750035f8c52a65da070c765269244d14)`(`[UAppUpdateOptions](/reference/unreal-engine/play/core/class/u-app-update-options#class_u_app_update_options)` *InAppUpdateOptions)` | `bool` Returns whether the update type is allowed. |\n\nPublic functions\n----------------\n\n### BeginDestroy\n\n```text\nvirtual void BeginDestroy() override\n``` \nPart of UObject interface.\n\nCalled when the object is marked for deletion by MarkPendingKill. \n\n### ClearAppUpdateInfo\n\n```text\nvoid ClearAppUpdateInfo()\n``` \nClears the native app update info object. \n\n### GetAvailability\n\n```text\nEAppUpdateAvailability GetAvailability()\n``` \nReturns the availability of the app update. \n\n### GetAvailableVersionCode\n\n```text\nint32 GetAvailableVersionCode()\n``` \nReturns the available version code of the app update. \n\n### GetBytesDownloaded\n\n```gdscript\nint64 GetBytesDownloaded()\n``` \nReturns the number of bytes downloaded so far. \n\n### GetClientVersionStalenessDays\n\n```text\nint32 GetClientVersionStalenessDays()\n``` \nReturns the number of days since the client version was last updated. \n\n### GetPriority\n\n```text\nint32 GetPriority()\n``` \nReturns the priority of the app update. \n\n### GetStatus\n\n```text\nEAppUpdateStatus GetStatus()\n``` \nReturns the status of the app update. \n\n### GetTotalBytesToDownload\n\n```gdscript\nint64 GetTotalBytesToDownload()\n``` \nReturns the total number of bytes to download. \n\n### IsUpdateTypeAllowed\n\n```scdoc\nbool IsUpdateTypeAllowed(\n UAppUpdateOptions *InAppUpdateOptions\n)\n``` \nReturns whether the update type is allowed.\n\n\u003cbr /\u003e\n\n| Details ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | `InAppUpdateOptions` | The [UAppUpdateOptions](/reference/unreal-engine/play/core/class/u-app-update-options#class_u_app_update_options) object which contains the type of update. | |"]]
