Stay organized with collections
Save and categorize content based on your preferences.
UInAppUpdatesManager
#include <InAppUpdatesManager.h>
The UInAppUpdatesManager class is used to request app update information, start an update or complete a flexible update.
Summary
Refer to https://developer.android.com/guide/playcore/in-app-updates for more details.
Inheritance
Inherits from: UGameInstanceSubsystem
Public functions
|
CompleteUpdate(FUpdateOperationCompletedDelegate InOnStartUpdateOperationCompleted)
|
void
Requests to complete a flexible in-app update flow that was started via the StartUpdate() function. |
Deinitialize() override
|
virtual void
|
Initialize(FSubsystemCollectionBase & Collection) override
|
virtual void
|
RequestInfo(FRequestInfoOperationCompletedDelegate InOnRequestInfoOperationCompleted)
|
void
Requests information about an update.
|
StartUpdate(UAppUpdateInfo *InUpdateInfo, UAppUpdateOptions *InUpdateOptions, FUpdateOperationCompletedDelegate InOnUpdateOperationCompleted)
|
void
Starts the in-app update flow.
|
Public functions
CompleteUpdate
void CompleteUpdate(
FUpdateOperationCompletedDelegate InOnStartUpdateOperationCompleted
)
Requests to complete a flexible in-app update flow that was started via the StartUpdate() function.
| Details |
| Parameters |
InOnStartUpdateOperationCompleted
|
The delegate to handle the completion of the function.
|
|
Deinitialize
virtual void Deinitialize() override
Initialize
virtual void Initialize(
FSubsystemCollectionBase & Collection
) override
RequestInfo
void RequestInfo(
FRequestInfoOperationCompletedDelegate InOnRequestInfoOperationCompleted
)
Requests information about an update.
Needs to be called once before StartUpdate() to obtain an AppUpdateInfo, which is required to launch the in-app update flow.
| Details |
| Parameters |
InOnRequestInfoOperationCompleted
|
The delegate to handle the completion of the request.
|
|
StartUpdate
void StartUpdate(
UAppUpdateInfo *InUpdateInfo,
UAppUpdateOptions *InUpdateOptions,
FUpdateOperationCompletedDelegate InOnUpdateOperationCompleted
)
Starts the in-app update flow.
Use the InUpdateInfo functions to monitor the current status and download progress of the ongoing update operation.
| Details |
| Parameters |
InUpdateInfo
|
The object containing information needed for an update.
|
InUpdateOptions
|
The object specifying the update flow type.
|
InOnUpdateOperationCompleted
|
The delegate to handle the completion of the function.
|
|
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-14 UTC."],[],[],null,["# UInAppUpdatesManager Class Reference\n\nUInAppUpdatesManager\n====================\n\n\n`#include \u003cInAppUpdatesManager.h\u003e`\n\nThe [UInAppUpdatesManager](/reference/unreal-engine/play/core/class/u-in-app-updates-manager#class_u_in_app_updates_manager) class is used to request app update information, start an update or complete a flexible update.\n\nSummary\n-------\n\nRefer to \u003chttps://developer.android.com/guide/playcore/in-app-updates\u003e for more details.\n\n### Inheritance\n\nInherits from: UGameInstanceSubsystem\n\n| ### Public functions ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CompleteUpdate](#class_u_in_app_updates_manager_1ac794245f27551e2cf081b1d086974334)`(FUpdateOperationCompletedDelegate InOnStartUpdateOperationCompleted)` | `void` Requests to complete a flexible in-app update flow that was started via the [StartUpdate()](/reference/unreal-engine/play/core/class/u-in-app-updates-manager#class_u_in_app_updates_manager_1a86c8b8fa3215134d855165487d865949) function. |\n| [Deinitialize](#class_u_in_app_updates_manager_1a1a810532cbdf2971edb9be3738227342)`() override` | `virtual void` |\n| [Initialize](#class_u_in_app_updates_manager_1a08549a7773f89fbf391de2573f373b24)`(FSubsystemCollectionBase & Collection) override` | `virtual void` |\n| [RequestInfo](#class_u_in_app_updates_manager_1aa4be87f1bab5c5ab92df67a9575550ec)`(FRequestInfoOperationCompletedDelegate InOnRequestInfoOperationCompleted)` | `void` Requests information about an update. |\n| [StartUpdate](#class_u_in_app_updates_manager_1a86c8b8fa3215134d855165487d865949)`(`[UAppUpdateInfo](/reference/unreal-engine/play/core/class/u-app-update-info#class_u_app_update_info)` *InUpdateInfo, `[UAppUpdateOptions](/reference/unreal-engine/play/core/class/u-app-update-options#class_u_app_update_options)` *InUpdateOptions, FUpdateOperationCompletedDelegate InOnUpdateOperationCompleted)` | `void` Starts the in-app update flow. |\n\nPublic functions\n----------------\n\n### CompleteUpdate\n\n```text\nvoid CompleteUpdate(\n FUpdateOperationCompletedDelegate InOnStartUpdateOperationCompleted\n)\n``` \nRequests to complete a flexible in-app update flow that was started via the [StartUpdate()](/reference/unreal-engine/play/core/class/u-in-app-updates-manager#class_u_in_app_updates_manager_1a86c8b8fa3215134d855165487d865949) function.\n\n\u003cbr /\u003e\n\n| Details ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |-------------------------------------|--------------------------------------------------------| | `InOnStartUpdateOperationCompleted` | The delegate to handle the completion of the function. | |\n\n### Deinitialize\n\n```text\nvirtual void Deinitialize() override\n``` \n\n### Initialize\n\n```text\nvirtual void Initialize(\n FSubsystemCollectionBase & Collection\n) override\n``` \n\n### RequestInfo\n\n```text\nvoid RequestInfo(\n FRequestInfoOperationCompletedDelegate InOnRequestInfoOperationCompleted\n)\n``` \nRequests information about an update.\n\nNeeds to be called once before [StartUpdate()](/reference/unreal-engine/play/core/class/u-in-app-updates-manager#class_u_in_app_updates_manager_1a86c8b8fa3215134d855165487d865949) to obtain an AppUpdateInfo, which is required to launch the in-app update flow.\n\n\u003cbr /\u003e\n\n| Details ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |-------------------------------------|-------------------------------------------------------| | `InOnRequestInfoOperationCompleted` | The delegate to handle the completion of the request. | |\n\n### StartUpdate\n\n```scdoc\nvoid StartUpdate(\n UAppUpdateInfo *InUpdateInfo,\n UAppUpdateOptions *InUpdateOptions,\n FUpdateOperationCompletedDelegate InOnUpdateOperationCompleted\n)\n``` \nStarts the in-app update flow.\n\nUse the InUpdateInfo functions to monitor the current status and download progress of the ongoing update operation.\n\n\u003cbr /\u003e\n\n| Details ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |--------------------------------|---------------------------------------------------------| | `InUpdateInfo` | The object containing information needed for an update. | | `InUpdateOptions` | The object specifying the update flow type. | | `InOnUpdateOperationCompleted` | The delegate to handle the completion of the function. | |"]]
