@sapui5/ts-types 1.100.0 → 1.101.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.101.0
 
 declare namespace sap {
   namespace ushell {
@@ -44,28 +44,6 @@ declare namespace sap {
         };
       }
 
-      namespace Container {
-        /**
-         * @SINCE 1.90.0
-         *
-         * An enumeration for the application work protect mode state.
-         */
-        type DirtyState = {
-          /**
-           * The embedded application is clean, there is no unsaved data.
-           */
-          CLEAN: "CLEAN";
-          /**
-           * The embedded application is dirty, the user has entered data that is not yet saved.
-           */
-          DIRTY: "DIRTY";
-          /**
-           * The embedded application container's dirty state cannot be determined because of technical reasons.
-           */
-          MAYBE_DIRTY: "MAYBE_DIRTY";
-        };
-      }
-
       namespace Personalization {
         /**
          * @SINCE 1.22.0
@@ -785,64 +763,69 @@ declare namespace sap {
       }
       /**
        * @SINCE 1.15.0
+       *
+       * The Unified Shell's CrossApplicationNavigation service allows to navigate to "external" targets outside
+       * of the currently running app (but still in scope of the current Fiori launchpad) or create links to such
+       * external targets.
+       *
+       * To use the CrossApplicationNavigation service you can retrive an instance via ushell's Container:
+       * ```javascript
+       *
+       * sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then(function (CrossApplicationNavigationService) {
+       *   // Do whatever you want...!
+       * });
+       * ```
+       *
+       *
+       * The CrossApplicationNavigation service currently provides platform independent functionality.
+       *
+       * The service is meant to be used by applications, plugins and shell components.
+       *
+       * Usage:
+       * ```javascript
+       *
+       *   sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService) {
+       *
+       *      oService.hrefForExternalAsync({
+       *          target : {
+       *              semanticObject: "Product",
+       *              action: "display"
+       *          },
+       *          params: {
+       *              "ProductID": "102343333"
+       *          }
+       *      }).then( function(sHref) {
+       *          // Place sHref somewhere in the DOM
+       *      });
+       *   });
+       *   ```
+       *
+       *
+       * Parameter names and values are case sensitive.
+       *
+       * Note that the usage of multi-valued parameters (specifying an array with more than one member as parameter
+       * value, e.g. `params : { A : ["a1", "a2"] }`) is possible with this API but **strongly discouraged**.
+       * Depending on the used platform / back-end implementation the target matching might not supported multi-value
+       * parameters. Furthermore, it is not guaranteed that additional parameter values specified in the back-end
+       * configuration are merged with parameter values passed in this method.
+       *
+       * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
+       * when serialized as UTF-8.
+       *
+       * Note that when receiving the values as startup parameters (as part of the component data object) single
+       * values are represented as an array of size 1. Above example is returned as ` deepEqual(getComponentData().startupParameters
+       * , { "ProductID" : [ "102343333" ] } ) `
+       *
+       * Make sure not to store security critical data within an URL. URLs may appear in a server log, be persisted
+       * inside and outside the system.
+       *
+       * Note: When constructing large URLs, the URLs may be shortened and persisted on a database server for
+       * prolonged time, the actual data is persisted under a key accessible to any User (guessing the key).
+       *
+       * The same restrictions apply for the Application state.
        */
       class CrossApplicationNavigation {
-        /**
-         * The Unified Shell's CrossApplicationNavigation service, which allows to navigate to external targets
-         * or create links to external targets
-         *
-         * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then(function
-         * (CrossApplicationNavigation) {});`. Constructs a new instance of the CrossApplicationNavigation service.
-         *
-         * CrossApplicationNavigation currently provides platform independent functionality.
-         *
-         * This interface is for usage by applications or shell renderers/containers.
-         *
-         * Usage:  sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService)
-         * {
-         *
-         * oService.hrefForExternalAsync({ target : { semanticObject : "Product", action : "display" }, params :
-         * { "ProductID" : "102343333" } }).then( function(sHref) { // do something with sHref }); });
-         *
-         * Parameter names and values are case sensitive.
-         *
-         * Note that the usage of multi-valued parameters (specifying an array with more than one member as parameter
-         * value, e.g. ` params : { A : ["a1", "a2"] } ` ) is possible with this API but **strongly discouraged**.
-         * Especially the navigation target matching performed at the back-end is not supported for multi-value
-         * parameters. Furthermore, it is not guaranteed that additional parameter values specified in the back-end
-         * configuration are merged with parameter values passed in this method.
-         *
-         * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
-         * when serialized as UTF-8
-         *
-         * Note that when receiving the values as startup parameters (as part of the component data object) single
-         * values are represented as an array of size 1. Above example is returned as ` deepEqual(getComponentData().startupParameters
-         * , { "ProductID" : [ "102343333" ] } ) `
-         *
-         * Make sure not to store security critical data within an URL. URLs may appear in a server log, be persisted
-         * inside and outside the system.
-         *
-         * Note: When constructing large URLs, the URLs may be shortened and persisted on a database server for
-         * prolonged time, the actual data is persisted under a key accessible to any User (guessing the key).
-         *
-         * The same restrictions apply for the Application state.
-         * See:
-         * 	sap.ushell.services.Container#getServiceAsync
-         */
-        constructor(
-          /**
-           * The Container Interface.
-           */
-          oContainerInterface: object,
-          /**
-           * The parameters.
-           */
-          sParameters: string,
-          /**
-           * Service Configuration.
-           */
-          oServiceConf: object
-        );
+        constructor();
 
         /**
          * Attempts to use the browser history to navigate to the previous app. A navigation to the Fiori Launchpad
@@ -871,8 +854,8 @@ declare namespace sap {
         /**
          * @SINCE 1.38.0
          *
-         * Resolves the given semantic object (or action) and business parameters to a list of links available to
-         * the user
+         * Resolves the given semantic object (and action) and business parameters to a list of links available
+         * to the user.
          */
         getLinks(
           /**
@@ -977,9 +960,9 @@ declare namespace sap {
          * returns the one tagged as a "primaryAction". If no inbound tagged as "primaryAction" exists, then the
          * intent of the first inbound (after sorting has been applied) matching the action "displayFactSheet".
          *
-         * The primary intent is determined by querying {@link CrossApplicationNavigation#getLinks} with the given
-         * semantic object and optional parameter. Then the resulting list is filtered to the outcome that a single
-         * item remains.
+         * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks}
+         * with the given semantic object and optional parameter. Then the resulting list is filtered to the outcome
+         * that a single item remains.
          */
         getPrimaryIntent(
           /**
@@ -987,7 +970,7 @@ declare namespace sap {
            */
           sSemanticObject: string,
           /**
-           * @see CrossApplicationNavigation#getSemanticObjectLinks for description.
+           * @see sap.ushell.services.CrossApplicationNavigation#getSemanticObjectLinks for description.
            */
           mParameters?: object
         ): jQuery.Deferred;
@@ -1081,7 +1064,8 @@ declare namespace sap {
          * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
          * instead.
          *
-         * Returns a string which can be put into the DOM (e.g. in a link tag)
+         * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
+         * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
          */
         hrefForExternal(
           /**
@@ -1127,7 +1111,8 @@ declare namespace sap {
          * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
          * instead.
          *
-         * Returns a string which can be put into the DOM (e.g. in a link tag)
+         * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
+         * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
          */
         hrefForExternal(
           /**
@@ -1223,9 +1208,10 @@ declare namespace sap {
          * Tells whether the given navigation intent(s) are supported for the given parameters, form factor etc.
          * "Supported" means that a valid navigation target is configured for the user for the given device.
          *
-         * This is effectively a test function for {@link toExternal}/ {@link hrefForExternal}. It is functionally
-         * equivalent to {@link isIntentSupported} but accepts the same interface as {@link toExternal}/ {@link
-         * hrefForExternal}.
+         * This is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal}/
+         * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}. It is functionally equivalent
+         * to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported} but accepts the same interface
+         * as {@link sap.ushell.services.CrossApplicationNavigation#toExternal}/ {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
          */
         isNavigationSupported(
           /**
@@ -1240,51 +1226,127 @@ declare namespace sap {
            */
           oComponent?: object
         ): jQuery.Promise;
+        /**
+         * Resolves the URL hash fragment.
+         *
+         * This function gets the hash part of the URL and returns the URL of the target application.
+         *
+         * This is an asynchronous operation.
+         */
+        resolveIntent(
+          /**
+           * The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as
+           * given in `location.hash`)! Example: `#SemanticObject-action?P1=V1&P2=A%20B%20C`
+           */
+          sHashFragment: string
+        ): jQuery.Promise;
         /**
          * @SINCE 1.15.0
          *
-         * Navigate to an specified external target (e.g. different launchpad application). Invocation will trigger
-         * an hash change and subsequent invocation of the application.
+         * Triggers a navigation to a specified target outside of the currently running application (e.g. different
+         * launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
          *
          * If the navigation target opens in a new window the running application may be retained.
          */
         toExternal(
           /**
-           * configuration object describing the target, e.g. ` { target : { semanticObject : "AnObject", action:
-           * "action" }, params : { A : "B" } } ` constructs sth. like `#AnObject-action?A=B&C=e&C=j`; or e.g. ` {
-           * target : { semanticObject : "AnObject", action: "action", context : "AB7F3C" }, params : { A : "B", c
-           * : "e" } } ` or `{ target : { shellHash : "SO-36&jumper=postman" } }` and navigate to it via changing
-           * the hash
+           * A configuration object describing the navigation target. The navigation target can be provided as its
+           * separate aspects like semantic object, action, paramters etc. in separate members of the configuration
+           * object.
+           *
+           * **Note:** Parameter values can contain special characters and must be provided unencoded; the function
+           * takes care for necessary encodings itself.
+           *
+           * Simple Example:
+           * ```javascript
+           *
+           * {
+           *   target: {
+           *     semanticObject: "Customer",
+           *     action: "display"
+           *   },
+           *   params: {
+           *     customerId: "0815-4711"
+           *   }
+           * }
+           * ```
            *
-           * A proper way for an application to generate a link to return to the home page of the Fiori launchpad
-           * is: `hrefForExternal( { target : { shellHash : "#" }})`
            *
-           * Do *not* use "#Shell-home" or "Shell-home" to navigate to a specific homepage!
+           * Example with text:
+           * ```javascript
+           *
+           * {
+           *   target: {
+           *     semanticObject: "Note",
+           *     action: "create"
+           *   },
+           *   params: {
+           *     noteText: "Thanks for reading the documentation!"
+           *   }
+           * }
+           * ```
            *
-           * The actual navigation may occur deferred!
            *
-           * Since version 1.56 this API accepts a sap-xapp-state-data parameter that can be used to launch and application
-           * with certain data, for example:
+           * Example with a given context:
            * ```javascript
            *
-           *   {
-           *     target : { semanticObject : "AnObject", action: "action" },
-           *     params : { "sap-xapp-state-data" : JSON.stringify({ a: "b", c: "d" }) }
+           * {
+           *   target: {
+           *     semanticObject: "AnObject",
+           *     action: "action",
+           *     context: "AB7F3C"
+           *   },
+           *   params: {
+           *     param1: "Value One"
            *   }
-           *   ```
+           * }
+           * ```
+           *
+           *
+           * Alternatively a `shellHash` can be provided that includes already all aspects of the navigation target:
+           * semantic object, action, intent paramters, app-specific route (incuding app paramters)
+           *
+           * **Note:** While parameters need to be url-encoded once when used in the `shellHash` the app specific
+           * route must not be encoded.
+           *
+           * Example with shellHash as target:
+           * ```javascript
+           *
+           * {
+           *   target: {
+           *     shellHash: "Note-update?noteText=You%20got%20quite%20far&/Notes/My First Note"
+           *   }
+           * }
+           * ```
+           *
+           *
+           * To navigate to the homepage of the Fiori launchpad, navigate to `{target: {shellHash: "#"}}`. Do not
+           * use "#Shell-home" or "Shell-home" to navigate to!
+           *
+           * To provide a complex paramter structure to a target app the pesudo parameter `sap-xapp-state-data` can
+           * be used.
+           *
+           * Example:
+           * ```javascript
            *
+           * {
+           *   ...
+           *   params : {
+           *     "sap-xapp-state-data": JSON.stringify({ a: "b", c: "d" })
+           *   }
+           * }
+           * ```
            *
-           * The data specified via "sap-xapp-state-data" are passed to the target application in the sap-xapp-state
-           * parameter.
            *
-           * Note that the sap-xapp-state-data parameter itself is not passed to the target application.
+           * The data specified via `sap-xapp-state-data` is passed to the target application in the `sap-xapp-state`
+           * parameter. The `sap-xapp-state-data` parameter itself is not passed to the target application.
            *
-           * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
-           * when serialized as UTF-8
+           * **Note:** The parameter length (including semantic object and action) shall not exceed 512 bytes when
+           * serialized as UTF-8.
            */
           oArgs: Object,
           /**
-           * an optional SAP UI5 Component,
+           * an optional UI5 component, used to logically attach a possibly generated app state.
            */
           oComponent?: object
         ): Promise<void>;
@@ -4062,6 +4124,28 @@ declare namespace sap {
       }
     }
 
+    namespace Container {
+      /**
+       * @SINCE 1.90.0
+       *
+       * An enumeration for the application work protect mode state.
+       */
+      type DirtyState = {
+        /**
+         * The embedded application is clean, there is no unsaved data.
+         */
+        CLEAN: "CLEAN";
+        /**
+         * The embedded application is dirty, the user has entered data that is not yet saved.
+         */
+        DIRTY: "DIRTY";
+        /**
+         * The embedded application container's dirty state cannot be determined because of technical reasons.
+         */
+        MAYBE_DIRTY: "MAYBE_DIRTY";
+      };
+    }
+
     namespace renderers {
       namespace fiori2 {
         interface $RendererSettings extends sap.ui.core.$UIComponentSettings {}
@@ -9455,6 +9539,358 @@ declare namespace sap {
       }
     }
 
+    /**
+     * @SINCE 1.15.0
+     *
+     * The Unified Shell's container which manages renderers, services, and adapters. The container is designed
+     * to be a singleton. Instead of creating an instance please access the central instance via namespace `sap.ushell.Container`.
+     */
+    class Container {
+      constructor();
+      /**
+       * @SINCE 1.21.1
+       *
+       * An enumeration for the application work protect mode state.
+       */
+      DirtyState: sap.ushell.Container.DirtyState;
+
+      /**
+       * @SINCE 1.15.0
+       *
+       * Logs out the current user from all relevant back-end systems, including the logon system itself. This
+       * member represents the default native implementation of logout. If SessionHandler was created, we register
+       * the alternate logout function using registerLogout function.
+       */
+      logout: undefined;
+
+      /**
+       * @SINCE 1.15.0
+       *
+       * Adds a system to the list of remote systems currently in use. On logout this list is processed and performs
+       * a logout for each system via the ContainerAdapter specific for its platform.
+       */
+      addRemoteSystem(
+        /**
+         * Remote system to be added.
+         */
+        oRemoteSystem: sap.ushell.System
+      ): void;
+      /**
+       * @SINCE 1.19.1
+       *
+       * Attaches a listener to the logout event. In case the bAsyncFunction parameter is true, the fnFunction
+       * must return a promise. FLP will wait for the promise to be resolved before doing the actual logout.
+       */
+      attachLogoutEvent(
+        /**
+         * Event handler to be attached.
+         */
+        fnFunction: Function,
+        /**
+         * Whether the function returns a Promise to wait for its resolvent (since 1.81.0).
+         */
+        bAsyncFunction: boolean
+      ): void;
+      /**
+       * @SINCE 1.34.1
+       *
+       * Attaches a listener to the rendererCreated event.
+       */
+      attachRendererCreatedEvent(
+        /**
+         * Event handler to be attached. If a renderer is created, this function is called with a parameter of instance
+         * `sap.ui.base.Event`. The event object provides the instance of the created renderer as parameter "renderer".
+         * If the renderer is a SAPUI5 UI component (i.e. extend `sap.ui.core.UIComponent`), the event parameter
+         * returns the component instance, i.e. it unwraps the renderer component from its component container.
+         */
+        fnFunction: Function
+      ): void;
+      /**
+       * @SINCE 1.21.2
+       *
+       * Cancels the logon procedure in the current frame, if any. This MUST be used by the logon frame provider
+       * in case the user wants to close the logon frame for good. It will report "Authentication cancelled" and
+       * let all pending requests for the current realm fail. As a side-effect, it also calls `destroy` on the
+       * logon frame provider.
+       * See:
+       * 	sap.ushell.services.Container#setLogonFrameProvider
+       */
+      cancelLogon(): void;
+      /**
+       * @SINCE 1.15.0
+       *
+       * Creates a new renderer instance for the given renderer name.
+       *
+       * Names without a dot are interpreted as package names within the default naming convention and will be
+       * expanded to `"sap.ushell.renderers." + sRendererName + ".Renderer"`. Names containing a dot are used
+       * "as is".
+       *
+       * The resulting name must point to a SAPUI5 object which is first required and then instantiated (without
+       * arguments). The object is expected to be a UI component (i.e. extend `sap.ui.core.UIComponent`), which
+       * is then automatically wrapped into a `sap.ui.core.ComponentContainer` control by this method. The `sap.ui.core.ComponentContainer`
+       * is created with `height` and `width` set to "100%" to accommodate the complete available space. Besides
+       * UICompoents a control (i.e. extend `sap.ui.core.Control`) is accepted, too.
+       *
+       * The returned renderer is supposed to be added to a direct child (for example `div`) of the `body` of
+       * the page and there should be no other parts of the page consuming space outside the renderer. Use CSS
+       * class `sapUShellFullHeight` at `html`, `body` and at the element to which the renderer is added to allow
+       * the renderer to use 100% height.
+       */
+      createRenderer(
+        /**
+         * The renderer name, such as "standard" or "acme.foo.bar.MyRenderer"; it is taken from the configuration
+         * property `defaultRenderer` if not given here.
+         */
+        sRendererName?: string,
+        /**
+         * If `true`, the renderer is created asynchronously and a `Promise` is returned.
+         */
+        bAsync?: boolean
+      ): sap.ui.core.Control | Promise<any>;
+      /**
+       * @SINCE 1.67.0
+       *
+       * Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information.
+       * Only the last registered function will be deregistered (in case it was registered multiple times).
+       */
+      deregisterDirtyStateProvider(
+        /**
+         * function for determining the state of the application
+         */
+        fnDirty: Function
+      ): void;
+      /**
+       * @SINCE 1.19.1
+       *
+       * Detaches a listener from the logout event.
+       */
+      detachLogoutEvent(
+        /**
+         * Event handler to be detached.
+         */
+        fnFunction: Function
+      ): void;
+      /**
+       * @SINCE 1.34.1
+       *
+       * Detaches a listener from the rendererCreated event.
+       */
+      detachRendererCreatedEvent(
+        /**
+         * Event handler to be detached.
+         */
+        fnFunction: Function
+      ): void;
+      /**
+       * @SINCE 1.27.0
+       *
+       * If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods
+       * get called to determine the actual dirty state. The determined dirty state is then returned.
+       *
+       * However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty state
+       * provider methods are ignored and the function simply returns 'true'.
+       */
+      getDirtyFlag(): boolean;
+      /**
+       * @SINCE 1.21.1
+       *
+       * Returns the global dirty state.
+       *
+       * All open UShell browser windows for the same origin are asked about their global dirty state.
+       */
+      getGlobalDirty(): jQuery.Deferred;
+      /**
+       * @SINCE 1.30.0
+       *
+       * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
+       */
+      getRenderer(
+        /**
+         * The renderer name, such as "standard" or "fiori2"; it is taken from the configuration property `defaultRenderer`
+         * if not given here.
+         */
+        sRendererName?: string
+      ): object;
+      /**
+       * @SINCE 1.15.0
+       * @deprecated (since 1.77) - deprecated. Uses {@link#getServiceAsync} instead.
+       *
+       * Returns a service with the given name, creating it if necessary. Services are singleton objects identified
+       * by their (resulting) name.
+       *
+       * Names without a dot are interpreted as service names within the default naming convention and will be
+       * expanded to `"sap.ushell.services." + sServiceName`. Names containing a dot are not yet supported. This
+       * name may be overridden via configuration. See example 2 below.
+       *
+       * The resulting name must point to a constructor function which is first required as a SAPUI5 module and
+       * then called to create a service instance. The service will be passed to a corresponding service adapter
+       * for the current logon system, as well as a callback interface (of virtual type `sap.ushell.services.ContainerInterface`)
+       * to the container providing a method `createAdapter(oSystem)` to create further adapters for the same
+       * service but connected to remote systems. The third parameter will be `sParameter` as passed to this function.
+       * The fourth parameter will be an object with the property `config` supplied by the configuration. See
+       * example 2 below.
+       *
+       * The adapter for the logon system will be created before the service. Its constructor gets three parameters.
+       * The first parameter is the logon system, the second parameter is `sParameter` and the third parameter
+       * is an object with the property `config` supplied by the configuration.
+       *
+       * The service may declare itself adapterless by setting the property `hasNoAdapter = true` at the constructor
+       * function. In this case no adapter will be created and passed to the constructor and all other parameters
+       * will be shifted.
+       *
+       * **Example 1:** The service `sap.ushell.services.UserInfo` is parameterless. It indicates this by setting
+       * `sap.ushell.services.UserInfo.hasNoAdapter = true;`.
+       *
+       * **Example 2:** (Configuration)
+       * ```javascript
+       *
+       *   window["sap-ushell-config"] = {
+       *     services: {
+       *       Foo: {
+       *         module: "my.own.Foo"
+       *         config: {header: "hidden"},
+       *         adapter: {
+       *           module: "my.own.FooAdapter",
+       *           config: {foo: "bar"}
+       *         }
+       *       }
+       *     }
+       *   }
+       *   sap.ushell.Container.getServiceAsync("Foo", "runtimeConfig")
+       *       .then(function (Foo) {
+       *           // Do something with the service
+       *       });
+       *   ```
+       *  Now `oService` is an instance of `my.own.Foo`. The third parameter of the constructor will be "runtimeConfig",
+       * the fourth parameter `{config: {header: "hidden"}}`. Its adapter is an instance of `my.own.FooAdapter`
+       * constructed with the parameters logon system, "runtimeConfig" and `{config: {foo: "bar"}}`.
+       *
+       * Please note that the api will throw a runtime error (or reject for async mode) if the service name does
+       * not reflect a service available.
+       * See:
+       * 	sap.ushell.services.ContainerInterface
+       */
+      getService(
+        /**
+         * The service name, such as "Menu"
+         */
+        sServiceName: string,
+        /**
+         * A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
+         */
+        sParameter?: string,
+        /**
+         * if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
+         */
+        bAsync?: boolean
+      ): object | Promise<any>;
+      /**
+       * @SINCE 1.55.0
+       *
+       * Returns a Promise that resolves a service with the given name, creating it if necessary. Services are
+       * singleton objects identified by their (resulting) name.
+       *
+       * Names without a dot are interpreted as service names within the default naming convention and will be
+       * expanded to `"sap.ushell.services." + sServiceName`. Names containing a dot are not yet supported. This
+       * name may be overridden via configuration. See example 2 below.
+       *
+       * The resulting name must point to a constructor function which is first required as a SAPUI5 module and
+       * then called to create a service instance. The service will be passed to a corresponding service adapter
+       * for the current logon system, as well as a callback interface (of virtual type `sap.ushell.services.ContainerInterface`)
+       * to the container providing a method `createAdapter(oSystem)` to create further adapters for the same
+       * service but connected to remote systems. The third parameter will be `sParameter` as passed to this function.
+       * The fourth parameter will be an object with the property `config` supplied by the configuration. See
+       * example 2 below.
+       *
+       * The adapter for the logon system will be created before the service. Its constructor gets three parameters.
+       * The first parameter is the logon system, the second parameter is `sParameter` and the third parameter
+       * is an object with the property `config` supplied by the configuration.
+       *
+       * The service may declare itself adapterless by setting the property `hasNoAdapter = true` at the constructor
+       * function. In this case no adapter will be created and passed to the constructor and all other parameters
+       * will be shifted.
+       *
+       * **Example 1:** The service `sap.ushell.services.UserInfo` is parameterless. It indicates this by setting
+       * `sap.ushell.services.UserInfo.hasNoAdapter = true;`.
+       *
+       * **Example 2:** (Configuration)
+       * ```javascript
+       *
+       *   window["sap-ushell-config"] = {
+       *     services: {
+       *       Foo: {
+       *         module: "my.own.Foo"
+       *         config: {header: "hidden"},
+       *         adapter: {
+       *           module: "my.own.FooAdapter",
+       *           config: {foo: "bar"}
+       *         }
+       *       }
+       *     }
+       *   }
+       *   sap.ushell.Container.getServiceAsync("Foo", "runtimeConfig")
+       *       .then(function (Foo) {
+       *           // Do something with the service
+       *       });
+       *   ```
+       *  Now the parameter provided in the promise handler is an instance of `my.own.Foo`. The third parameter
+       * of the constructor will be "runtimeConfig", the fourth parameter `{config: {header: "hidden"}}`. Its
+       * adapter is an instance of `my.own.FooAdapter` constructed with the parameters logon system, "runtimeConfig"
+       * and `{config: {foo: "bar"}}`.
+       * See:
+       * 	sap.ushell.services.ContainerInterface
+       */
+      getServiceAsync(
+        /**
+         * The service name, such as "Menu"
+         */
+        sServiceName: string,
+        /**
+         * A parameter which is passed to the service constructor and every adapter constructor.
+         */
+        sParameter?: string
+      ): Promise<any>;
+      /**
+       * @SINCE 1.31.0
+       *
+       * Register the work protection dirty callback function. In the work protect mechanism, each platform can
+       * register their own method in order to check if data was changed during the session, and notify the container
+       * about the change. Multiple registerings of the same function are allowed.
+       *
+       * Use `Function.prototype.bind()` to determine the callback's `this` or some of its arguments.
+       */
+      registerDirtyStateProvider(
+        /**
+         * Function for determining the state of the application. The callback is used to determine the current
+         * dirty state during a navigation. The function must return a boolean which determines if the current application
+         * is dirty or not. If `true` is returned the end user is prompted with a dialog where they need to confirm
+         * the potential data loss. The callback is called with a navigation context as its first parameter which
+         * can be used to determine the dirty state:
+         * ```javascript
+         *
+         *  {
+         *    status: "InProgress", // Enum which determines if a navigation currently takes place or if it is already finished. See sap.ushell.NavigationState.
+         *    isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app our across two different applications.
+         *    innerAppRoute: "&/SalesOrder/11" // If it is an inner app navigation, it describes the inner app route.
+         *  }
+         *  ```
+         */
+        fnDirty: Function
+      ): void;
+      /**
+       * @SINCE 1.27.0
+       *
+       * Setter for the isDirty flag value.
+       *
+       * Default value is false
+       */
+      setDirtyFlag(
+        /**
+         * The value of the dirty flag.
+         */
+        bIsDirty?: boolean
+      ): void;
+    }
     /**
      * @SINCE 1.15.0
      *