DefaultNotificationText_Complete

DefaultNotificationText_Complete

#Overview

name: DefaultNotificationText_Complete

The value of this variable can be defined or overridden in .ini config files. 15 .ini config files referencing this setting variable.

It is referenced in 5 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of DefaultNotificationText_Complete is to provide the default text for a notification indicating the completion of a background download task in Android applications using Unreal Engine 5.

This setting variable is primarily used by the Android Background HTTP Manager, which is part of the AndroidFetchBackgroundDownload plugin. This plugin is responsible for managing background downloads on Android devices.

The value of this variable is set through an INI configuration file. It is initialized in the InitFromIniSettings function of the FAndroidBackgroundHTTPManagerDefaultLocalizedText struct, where it reads the value from a configuration section using the key “DefaultNotificationText_Complete”.

DefaultNotificationText_Complete interacts with other similar variables such as DefaultNotificationText_Title, DefaultNotificationText_Content, DefaultNotificationText_Cancel, and others. These variables collectively provide localized text for various states and actions related to background downloads.

Developers must be aware that this variable is part of a localization system. It uses FPolyglotTextData, which suggests that it supports multiple languages. When using this variable, developers should ensure that appropriate translations are provided for all supported languages.

Best practices when using this variable include:

1. Providing clear and concise completion messages that are easily understood by users.
2. Ensuring that the text is properly localized for all target languages.
3. Considering the limited space in notifications when crafting the message.
4. Maintaining consistency with the app’s overall tone and style in the notification text.
5. Regularly reviewing and updating the text to ensure it remains relevant and accurate.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:40, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("native","Download Complete")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:41, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("ar","اكتمل التنزيل")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:42, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("de","Download abgeschlossen")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:43, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("es","Descarga completada")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:44, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("es-419","Descarga completa")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:45, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("fr","Téléchargement terminé")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:46, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("it","Download completato")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:47, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("ja","ダウンロード完了")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:48, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("ko","다운로드 완료")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:49, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("pl","Pobieranie zakończone")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:50, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("pt-BR","Download Concluído")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:51, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("ru","Загрузка завершена")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:52, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("tr","İndirme Tamamlandı")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:53, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("zh-CN","下载完成")
• Is Array: True

Location: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Config/BaseAndroidFetchBackgroundDownload.ini:54, section: [AndroidBackgroundHTTP.DefaultTextLoc]

• INI Section: AndroidBackgroundHTTP.DefaultTextLoc
• Raw value: ("zh-Hant","下載完成")
• Is Array: True

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Source/AndroidFetchBackgroundDownload/Private/AndroidPlatformBackgroundHttpManager.cpp:355

Scope (from outer to inner):

file
function     void FAndroidPlatformBackgroundHttpManager::ActivatePendingRequests

Source code excerpt:

				//Make sure we pass in localized notification text bits for the important worker keys
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_TITLE_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_Title.GetText());
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_COMPLETE_TEXT_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_Complete.GetText());
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_CANCEL_DOWNLOAD_TEXT_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_Cancel.GetText());
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_NO_INTERNET_TEXT_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_NoInternet.GetText());
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_WAITING_FOR_CELLULAR_TEXT_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_WaitingForCellular.GetText());
				WorkParams.AddDataToWorkerParameters(FAndroidNativeDownloadWorkerParameterKeys::NOTIFICATION_CONTENT_APPROVE_TEXT_KEY, AndroidBackgroundHTTPManagerDefaultLocalizedText.DefaultNotificationText_Approve.GetText());

				//Expect our ContentText to have a {DownloadPercent} argument in it by default, so this will replace that with the Java string format argument so Java can insert the appropriate value

#Loc: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Source/AndroidFetchBackgroundDownload/Private/AndroidPlatformBackgroundHttpManager.cpp:1037

Scope (from outer to inner):

file
function     FAndroidPlatformBackgroundHttpManager::FAndroidBackgroundHTTPManagerDefaultLocalizedText::FAndroidBackgroundHTTPManagerDefaultLocalizedText::FAndroidBackgroundHTTPManagerDefaultLocalizedText

Source code excerpt:

	: DefaultNotificationText_Title()
	, DefaultNotificationText_Content()
	, DefaultNotificationText_Complete()
	, DefaultNotificationText_Cancel()
	, DefaultNotificationText_NoInternet()
	, DefaultNotificationText_WaitingForCellular()
	, DefaultNotificationText_Approve()
{
}

#Loc: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Source/AndroidFetchBackgroundDownload/Private/AndroidPlatformBackgroundHttpManager.cpp:1068

Scope (from outer to inner):

file
function     void FAndroidPlatformBackgroundHttpManager::FAndroidBackgroundHTTPManagerDefaultLocalizedText::InitFromIniSettings

Source code excerpt:

			}

			//DefaultNotificationText_Complete
			{
				TArray<FString> CompleteTextStrings;
				Config->GetArray(*TextConfigSection, TEXT("DefaultNotificationText_Complete"), CompleteTextStrings);
				ParsePolyglotTextItem(DefaultNotificationText_Complete, TEXT("Notification.CompletedContentText"), CompleteTextStrings);
			}

			//DefaultNotificationText_Cancel
			{
				TArray<FString> CancelTextStrings;
				Config->GetArray(*TextConfigSection, TEXT("DefaultNotificationText_Cancel"), CancelTextStrings);

#Loc: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Source/AndroidFetchBackgroundDownload/Private/AndroidPlatformBackgroundHttpManager.cpp:1109

Scope (from outer to inner):

file
function     void FAndroidPlatformBackgroundHttpManager::FAndroidBackgroundHTTPManagerDefaultLocalizedText::InitFromIniSettings

Source code excerpt:

	ForceValidPolyglotText(DefaultNotificationText_Title, TEXT("DefaultNotificationText_Title"));
	ForceValidPolyglotText(DefaultNotificationText_Content, TEXT("DefaultNotificationText_Content"));
	ForceValidPolyglotText(DefaultNotificationText_Complete, TEXT("DefaultNotificationText_Complete"));
	ForceValidPolyglotText(DefaultNotificationText_Cancel, TEXT("DefaultNotificationText_Cancel"));
	ForceValidPolyglotText(DefaultNotificationText_NoInternet, TEXT("DefaultNotificationText_NoInternet"));
	ForceValidPolyglotText(DefaultNotificationText_WaitingForCellular, TEXT("DefaultNotificationText_WaitingForCellular"));
	ForceValidPolyglotText(DefaultNotificationText_Approve, TEXT("DefaultNotificationText_Approve"));
}

#Loc: <Workspace>/Engine/Plugins/Online/Android/AndroidFetchBackgroundDownload/Source/AndroidFetchBackgroundDownload/Public/AndroidPlatformBackgroundHttpManager.h:154

Scope (from outer to inner):

file
class        class FAndroidPlatformBackgroundHttpManager : public FBackgroundHttpManagerImpl

Source code excerpt:

		FPolyglotTextData DefaultNotificationText_Title;
		FPolyglotTextData DefaultNotificationText_Content;
		FPolyglotTextData DefaultNotificationText_Complete;
		FPolyglotTextData DefaultNotificationText_Cancel;
		FPolyglotTextData DefaultNotificationText_NoInternet;
		FPolyglotTextData DefaultNotificationText_WaitingForCellular;
		FPolyglotTextData DefaultNotificationText_Approve;