Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface STF_API

Hierarchy

  • STF_API

Index

Methods

Methods

getService

  • getService(id: string, serviceName: string): Promise<Object>

  • Exposes a service from the SAP Web IDE instance.

    Parameters

    • id: string
    • serviceName: string

    Returns Promise<Object>

getServicePartial

  • getServicePartial(id: string): (serviceName: string) => Promise<Object>

  • Utility to get a partial function with a bound "suiteName" argument. This can be used to reduce verbosity and mistakes coming from copying pasting.

    Parameters

    • id: string

    Returns (serviceName: string) => Promise<Object>

      • (serviceName: string): Promise<Object>

      • Utility to get a partial function with a bound "suiteName" argument. This can be used to reduce verbosity and mistakes coming from copying pasting.

        Parameters

        • serviceName: string

        Returns Promise<Object>

getServicePrivateImpl

  • getServicePrivateImpl(Service: Object): Promise<Object>

  • Exposes the original AMD module of an SAP Web IDE service proxy. This can allow accessing "private" methods on a service.

    Parameters

    • Service: Object

    Returns Promise<Object>

require

  • require(id: string, depPaths: string[]): Promise<Object>

  • Exposes the "require.js" AMD modules from the "iframe" of the SAP Web IDE instance.

    Parameters

    • id: string
    • depPaths: string[]

    Returns Promise<Object>

shutdownWebIde

  • shutdownWebIde(id: string): void

startWebIDE

  • startWebIDE(id: string, options?: { env?: Object; featureConfig?: Object; html?: string; ideDebug?: boolean; mocks?: "IN_MEMORY_BACKEND"[]; pluginsTransformDef?: PluginsTransformDef; ui5Debug?: boolean; ui5Root?: string; urlParams?: {} }): Promise<void>

  • Parameters

    • id: string
    • Optional options: { env?: Object; featureConfig?: Object; html?: string; ideDebug?: boolean; mocks?: "IN_MEMORY_BACKEND"[]; pluginsTransformDef?: PluginsTransformDef; ui5Debug?: boolean; ui5Root?: string; urlParams?: {} }
      • Optional env?: Object

        An SAP Web IDE "env.json" object (NOT a URL link to one).

      • Optional featureConfig?: Object

        An SAP Web IDE feature configuration to be used as the root configuration when starting SAP Web IDE.

      • Optional html?: string

        Default value is: "/base/node_modules/webide/src/main/webapp/index.html".

      • Optional ideDebug?: boolean

        Flag to enable or disable the use of the "sap-ide-debug=true" flag in the SAP Web IDE URL.

      • Optional mocks?: "IN_MEMORY_BACKEND"[]

        Common presets for using "pluginsTransformDef" to mock (i.e., replace) SAP Web IDE capabilities. Most commonly used to mock the back-end service to allow testing with an "in-memory" fake file system.

      • Optional pluginsTransformDef?: PluginsTransformDef

        Definition of SAP Web IDE plugin transformation that happens BEFORE any plugins are registered in the "pluginRegistry". This allows using mock plugins or adding plugins to the SAP Web IDE instance that starts during tests.

      • Optional ui5Debug?: boolean

        Flag to enable or disable the use of the "sap-ui-debug=true" flag in the SAP Web IDE URL.

      • Optional ui5Root?: string

        Path to load SAPUI5 from this instance of SAP Web IDE.

      • Optional urlParams?: {}

        Additional url params passed to the webide instance for example: { user: "TECHNICAL_USER", myFlag: "myValue" }

        • [key: string]: string

    Returns Promise<void>

    For the window where SAP Web Ide is running. This is resolved when the SAP Web IDE core has finished loading (all_plugins_started).

Generated using TypeDoc