Interface ITranslationStudioApi
public interface ITranslationStudioApi
- Author:
- I-D Media AG
-
Method Summary
Modifier and TypeMethodDescription@NotNull ITranslationStudioApplicationAccess application information@NotNull ICommonsGeneric commons@NotNull IConfigurationRequest the current configuration@NotNull IConfigurationBrokerDeprecated.@NotNull ITranslationMemoryConnectorFactoryGet factory to instanciate connectors@NotNull IContentManagementSystemGet the CMS API to access the content management system@NotNull IDatabaseQueriesGet database query instance@NotNull IFilesystemManagerTypical filesystem operations@NotNull ISymmetricHasherHash utility@NotNull IHookBrokerDeprecated.Use connector events instead@NotNull ILicenseManagerGet the license managerSome common operations@NotNull IServiceBrokerGet service broker@NotNull ISpecialistBrokerGet specialist brokerlongGet the startup timestamp@NotNull ISymmetricEncryptionEncrypt or decrypt instance.@NotNull ISymmetricEncryptionEncrypt or decrypt instance.@NotNull ITranslatableTxtBrokerObtain third-party txt field processor@NotNull IVersionInfoGet version informationbooleanCheck if the application is within non-working hoursbooleanisReady()Is the API ready@NotNull ISmtpEmailSpecialistSpecialist to send emailsvoidsetContentManagementSystem(@NotNull String sCmsType) Set the CMS API to access the content management system
-
Method Details
-
getFilesystemManager
Typical filesystem operations- Returns:
-
getConfigurationBroker
Deprecated.usegetConfigurationRequest a valid configuration- Returns:
-
getConfiguration
Request the current configuration- Returns:
-
getLicenseManager
Get the license manager- Returns:
-
getServiceBroker
Get service broker- Returns:
-
requestCustomEmailService
Specialist to send emails- Returns:
-
getSymmetricEncryption
Encrypt or decrypt instance. This key is shorter for faster encryption/decryption.- Returns:
-
getSymmetricEncryptionRSA
Encrypt or decrypt instance. This is a 2048 bit key- Returns:
-
getDatabaseQueries
Get database query instance- Returns:
-
getConnectorFactory
Get factory to instanciate connectors- Returns:
-
getVersion
Get version information- Returns:
-
getHookBroker
Deprecated.Use connector events insteadObtain the hook broker.- Returns:
-
getHasher
Hash utility- Returns:
-
getCommons
Generic commons- Returns:
-
getOperationBroker
IOperationBroker getOperationBroker()Some common operations- Returns:
-
getApplication
Access application information- Returns:
-
getTranslatableTxtBroker
Obtain third-party txt field processor- Returns:
-
getSpecialistBroker
Get specialist broker- Returns:
-
getContentManagementSystem
Get the CMS API to access the content management system- Returns:
-
setContentManagementSystem
Set the CMS API to access the content management system- Parameters:
sCmsType-
-
getStartupTime
long getStartupTime()Get the startup timestamp- Returns:
-
isReady
boolean isReady()Is the API ready- Returns:
-
isInNonWorkingMode
boolean isInNonWorkingMode()Check if the application is within non-working hours- Returns:
-
getTranslationstudioErrorNotificationCollector
@NotNull @NotNull ITranslationstudioErrorNotificationCollector getTranslationstudioErrorNotificationCollector()
-
getConfiguration