1. Epic GamesDeveloper
  3. ILocalizationServiceProvider

ILocalizationServiceProvider

Interface to talking with localization service providers.

API > API/Developer > API/Developer/LocalizationService

Inheritance Hierarchy

References

   
Module LocalizationService
Header /Engine/Source/Developer/LocalizationService/Public/ILocalizationServiceProvider.h
Include #include "ILocalizationServiceProvider.h"

Syntax

class ILocalizationServiceProvider : public IModularFeature

Remarks

Interface to talking with localization service providers.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const bool

CanCancelOperation ( const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation
)

 Check to see if we can cancel an operation.
Public function void

CancelOperation ( const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation
)

 Attempt to cancel an operation in progress.
Public function void

Close ()

 Shut down localization service provider.
Public function Const void Create a settings widget for display in the localization dashboard.
Public function Const void

CustomizeTargetDetails ( IDetailCategoryBuilder& DetailCategoryBuilder,
TWeakObjectPtr< ULocalizationTarget > LocalizationTarget
)

 Create a settings widget for display in the localization target editor.
Public function Const void Create a settings widget for display in the localization target set editor.
Public function Const void

CustomizeTargetToolbar ( TSharedRef< FExtender >& MenuExtender,
TWeakObjectPtr< ULocalizationTarget > LocalizationTarget
)

 Create a settings widget for display in the localization target editor.
Public function Virtual ELocalizationServiceOperationCommandResult::Type

Execute ( const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation,
const FLocalizationServiceTranslationIdentifier& InTranslationId,
const ELocalizationServiceOperationConcurrency::Type InConcurrency,
const FLocalizationServiceOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function ELocalizationServiceOperationCommandResult::Type

Execute ( const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation,
const TArray< FLocalizationServiceTranslationIdentifier >& InTranslationIds,
ELocalizationServiceOperationConcurrency::Type InConcurrency,
const FLocalizationServiceOperationComplete& InOperationCompleteDelegate
)

 Attempt to execute an operation on the passed-in files (if any are required).
Public function Virtual ELocalizationServiceOperationCommandResult::Type

Execute ( const TSharedRef< ILocalizationServiceOperation, ESPMode::ThreadSafe >& InOperation,
const ELocalizationServiceOperationConcurrency::Type InConcurrency,
const FLocalizationServiceOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Const const FText Get the localization service provider display name
Public function Const const FName &

GetName ()

 Get the localization service provider name
Public function ELocalizationServiceOperationCommandResult::Type

GetState ( const TArray< FLocalizationServiceTranslationIdentifier >& InTranslationIds,
TArray< TSharedRef< ILocalizationServiceState, ESPMode::ThreadSafe > >& OutState,
ELocalizationServiceCacheUsage::Type InStateCacheUsage
)

 Get the state of each of the passed-in files.
Public function Virtual TSharedPtr< ILocalizationServiceState, ESPMode::ThreadSafe > Helper overload for state retrieval, see GetState().
Public function Const FText Get the localization service status as plain, human-readable text
Public function void

Init ( bool bForceConnection
)

 Initialize localization service provider.
Public function Const bool Quick check if localization service is available for use (server-based providers can use this to return whether the server is available or not)
Public function Const bool Quick check if localization service is enabled
Public function Virtual ELocalizationServiceOperationCommandResult::Type

Login ( const FString& InPassword,
ELocalizationServiceOperationConcurrency::Type InConcurrency,
const FLocalizationServiceOperationComplete& InOperationCompleteDelegate
)

 Login to the localization service server (if any).
Public function void

Tick ()

 Called every update.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page