Package com.inductiveautomation.perspective.common.rpc

Interface PerspectiveModuleRpc

All Known Implementing Classes:
PerspectiveGatewayRpc
public interface PerspectiveModuleRpc
RPC Interface for the Perspective Module. Make sure that all objects types in the method signatures are serializable by either GSON or ProtoBuf. This requirement is transitive to all nested objects as well.

  • Field Details

  • Method Details

    • designerScriptsModified

      void designerScriptsModified(List<Resource> moduleLibraryScripts, @Nullable Resource 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.

    • designerSaved

      void designerSaved()
      Called to notify that the designer has saved successfully.

    • designerSessionPropsChanged

      void designerSessionPropsChanged(Resource 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

    • getAllAvailableTranslations

      List<Translation> getAllAvailableTranslations()
      Get all available translations from the Gateway
      Returns:
      A List of all the available translations

    • 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

    • getIdentityProvider

      @Deprecated(since="8.3.0") Optional<IdentityProviderMeta> getIdentityProvider(String id)
      Deprecated.
      this method is for providing the legacy Perspective project prop ID to the perspective project property panel in the Designer and is not intended for any other use case. avoid using this method as it may be removed in the future.
      Get Identity Provider by ID.
      Returns:
      an Optional containing the IdentityProviderMeta for the Identity Provider with the given ID, or empty if no Identity Provider exists with the given ID.