Navigation
API > API/Developer > API/Developer/LocalizationService
Interface to talking with localization service providers.
| Name | ILocalizationServiceProvider |
| Type | class |
| Header File | /Engine/Source/Developer/LocalizationService/Public/ILocalizationServiceProvider.h |
| Include Path | #include "ILocalizationServiceProvider.h" |
Syntax
class ILocalizationServiceProvider : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ILocalizationServiceProvider() |
Virtual destructor | ILocalizationServiceProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanCancelOperation
(
const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation |
Check to see if we can cancel an operation. | ILocalizationServiceProvider.h | |
void CancelOperation
(
const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation |
Attempt to cancel an operation in progress. | ILocalizationServiceProvider.h | |
void Close() |
Shut down localization service provider. | ILocalizationServiceProvider.h | |
void CustomizeSettingsDetails
(
IDetailCategoryBuilder& DetailCategoryBuilder |
Create a settings widget for display in the localization dashboard. | ILocalizationServiceProvider.h | |
void CustomizeTargetDetails
(
IDetailCategoryBuilder& DetailCategoryBuilder, |
Create a settings widget for display in the localization target editor. | ILocalizationServiceProvider.h | |
void CustomizeTargetSetToolbar
(
TSharedRef< FExtender >& MenuExtender, |
Create a settings widget for display in the localization target set editor. | ILocalizationServiceProvider.h | |
void CustomizeTargetToolbar
(
TSharedRef< FExtender >& MenuExtender, |
Create a settings widget for display in the localization target editor. | ILocalizationServiceProvider.h | |
virtual ELocalizationServiceOperationCommandResult::Type Execute
(
const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation, |
Helper overload for operation execution, see Execute(). | ILocalizationServiceProvider.h | |
ELocalizationServiceOperationCommandResult::Type Execute
(
const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation, |
Attempt to execute an operation on the passed-in files (if any are required). | ILocalizationServiceProvider.h | |
virtual ELocalizationServiceOperationCommandResult::Type Execute
(
const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation, |
Helper overload for operation execution, see Execute(). | ILocalizationServiceProvider.h | |
const FText GetDisplayName() |
Get the localization service provider display name | ILocalizationServiceProvider.h | |
const FName & GetName() |
Get the localization service provider name | ILocalizationServiceProvider.h | |
ELocalizationServiceOperationCommandResult::Type GetState
(
const TArray< FLocalizationServiceTranslationIdentifier >& InTranslationIds, |
Get the state of each of the passed-in files. | ILocalizationServiceProvider.h | |
virtual TSharedPtr< ILocalizationServiceState, ESPMode::ThreadSafe > GetState
(
const FLocalizationServiceTranslationIdentifier& InTranslationId, |
Helper overload for state retrieval, see GetState(). | ILocalizationServiceProvider.h | |
FText GetStatusText() |
Get the localization service status as plain, human-readable text | ILocalizationServiceProvider.h | |
void Init
(
bool bForceConnection |
Initialize localization service provider. | ILocalizationServiceProvider.h | |
bool IsAvailable() |
Quick check if localization service is available for use (server-based providers can use this to return whether the server is available or not) | ILocalizationServiceProvider.h | |
bool IsEnabled() |
Quick check if localization service is enabled | ILocalizationServiceProvider.h | |
virtual ELocalizationServiceOperationCommandResult::Type Login
(
const FString& InPassword, |
Login to the localization service server (if any). | ILocalizationServiceProvider.h | |
void Tick() |
Called every update. | ILocalizationServiceProvider.h |