Package com.inductiveautomation.ignition.common.i18n

Interface LocalizationRpc

public interface LocalizationRpc
RPC interface for managing localization settings, translation packages, and keyboard layouts.

  • Field Details

    • GSON

      static final com.inductiveautomation.ignition.common.gson.Gson GSON

    • SERIALIZER

      static final ProtoRpcSerializer SERIALIZER

  • Method Details

    • storeDiff

      void storeDiff(TranslationPackageDiff diff)
      Stores a set of translation changes.
      Parameters:
      diff - The differences to store.

    • loadFullPackage

      TranslationPackage loadFullPackage()
      Loads the complete translation package.
      Returns:
      The full TranslationPackage.

    • saveTranslationSettings

      void saveTranslationSettings(TranslationSettings settings)
      Saves the general translation settings.
      Parameters:
      settings - The settings to save.

    • getTranslationSettings

      TranslationSettings getTranslationSettings()
      Retrieves the current translation settings.
      Returns:
      The current TranslationSettings.

    • updateKeyboardLayouts

      void updateKeyboardLayouts(com.inductiveautomation.ignition.common.i18n.keyboard.KeyboardLayoutDiff diff) throws Exception
      Updates keyboard layouts based on the provided diff.
      Parameters:
      diff - The differences in keyboard layouts.
      Throws:
      Exception - If an error occurs during update.

    • customizeGson

      static com.inductiveautomation.ignition.common.gson.GsonBuilder customizeGson(com.inductiveautomation.ignition.common.gson.GsonBuilder builder)
      Configures a GsonBuilder with specific adapters required for i18n classes.
      Parameters:
      builder - The builder to customize.
      Returns:
      The customized builder.