Package com.inductiveautomation.perspective.common

Interface PerspectiveModuleRpc

All Known Implementing Classes:
PerspectiveModuleRpcImpl
public interface PerspectiveModuleRpc
RPC Interface for the Perspective Module. Like all RPC interfaces, ensure that all types referenced in concrete implementations of this interface's method arguments and return types are java-serializable and follow good java serialization best practices.

  • Method Details

    • designerScriptsModified

      void designerScriptsModified(List<ProjectResource> moduleLibraryScripts, @Nullable ProjectResource legacyAppScripts)
      Updates the necessary Script Managers on the Gateway when the Designer scripts change so that the designer session's models running on the gateway act against the latest unsaved Designer changes.
      Parameters:
      moduleLibraryScripts - List of all module library scripts in the project
      legacyAppScripts - The resource that holds the legacy app.* scripts, if any, or else null.

    • designerNamedQueriesModified

      void designerNamedQueriesModified(Map<String,NamedQuery> namedQueryMap)
      Updates the PerspectiveDesignSession on the Gateway with the named query changes local to this Designer instance so that executions of named queries on the Gateway reflect the latest changes in this Designer instance.
      Parameters:
      namedQueryMap - A Map of named query paths to the serialized bytes of NamedQuery instances for those named queries which have changed in this Designer instance. Null NamedQuery values mean that the NamedQuery with the given path has been deleted locally.

    • designerTabClosed

      void designerTabClosed(String viewPath)
      Called to notify the gateway that a page was closed, an the corresponding Page should be shut down.

    • designerStartup

      void designerStartup()
      Called to notify that a designer has started. Even though no views are running, the session props will start.

    • designerShutdown

      void designerShutdown()
      Called to notify that the designer has closed. Used for more timely shutdown of the session-side models, in cases where the designer closes cleanly.

    • designerSessionPropsChanged

      void designerSessionPropsChanged(ProjectResource newSessionProps)
      Called to notify that the designer has applied a new session props resource.

    • getAllAvailableLocales

      List<Locale> getAllAvailableLocales()
      Get all of the available locales from the Gateway
      Returns:
      A List of all the available locales

    • getAllAvailableThemes

      List<String> getAllAvailableThemes()
      Get all of the available themes from the Gateway's Theme Manager.
      Returns:
      A List of all the available themes

    • getAllAvailableIcons

      Map<String,List<String>> getAllAvailableIcons()
      Fetch a map of all icon library names and their respective icon names
      Returns:
      A map of all icon library names and their respective lists of icon names

    • getAllAvailableFonts

      List<PerspectiveFont> getAllAvailableFonts()
      Get all of the available fonts from the Gateway's Font Manager.
      Returns:
      A List of all the available fonts

    • getAllAvailableSecurityLevels

      List<String> getAllAvailableSecurityLevels()
      Returns:
      a List of all the available gson-serialized security level configs

    • getAllAvailableIdpAdapters

      Map<String,IdpAdapterMeta> getAllAvailableIdpAdapters()
      Get all of the available IdP adapters from the Gateway's IdP Adapter Manager.
      Returns:
      a Map of all the available IdpAdapterMeta keyed by their internal IDs