@sapui5/types 1.120.4 → 1.120.6

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.4
+// For Library Version: 1.120.6
 
 declare module "sap/ushell/library" {
   /**
@@ -7366,6 +7366,117 @@ declare module "sap/ushell/services/PersonalizationV2/ContextContainer" {
      * To be called by the personalization service getContainer method.
      */
     constructor();
+
+    /**
+     * @since 1.120.0
+     *
+     * clears the local copy data of this container
+     */
+    clearData(): void;
+    /**
+     * @since 1.120.0
+     *
+     * Checks if a specific direct item is contained in the container.
+     *
+     * @returns `true` if the container contains a direct item with the key
+     */
+    containsItem(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): boolean;
+    /**
+     * @since 1.120.0
+     *
+     * Deletes a direct item from the container. In case the item does not exist, nothing happens.
+     */
+    deleteItem(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): void;
+    /**
+     * @since 1.120.0
+     *
+     * flush all pending request; The result of the promise may reflect the last pending operation in the queue
+     *
+     * @returns promise
+     */
+    flushPendingRequests(): Promise<any>;
+    /**
+     * @since 1.120.0
+     *
+     * Returns an array with the keys of direct items in the container.
+     *
+     * @returns item keys
+     */
+    getItemKeys(): string[];
+    /**
+     * @since 1.120.0
+     *
+     * Returns the value for a direct item from the container. (Value semantics, new copy is returned)
+     *
+     * @returns item value (JSON object). In case the container does not contain a direct item with this key
+     * `undefined` is returned.
+     */
+    getItemValue(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): object;
+    /**
+     * @since 1.120.0
+     *
+     * return the container key as a string variable
+     *
+     * @returns the container key
+     */
+    getKey(): string;
+    /**
+     * @since 1.120.0
+     *
+     * (Re)loads the current container data from the underlying storage asynchronously. The current local data
+     * is discarded.
+     *
+     * Returns a promise for the load operation. If another save/load/delete operation is not completed, the
+     * operation may fail! (wait for the other promise).
+     *
+     * Synchronous read and write operations before the load is done have undefined effects.
+     *
+     * @returns Promise object
+     */
+    load(): Promise<object>;
+    /**
+     * @since 1.120.0
+     *
+     * * todo: jsdoc Save the current container data at the underlying storage asynchronously at the earlies
+     * nDelayInMilliseconds seconds before. The current state is serialized.
+     *
+     * @returns Promise object
+     *
+     * The operation may wait for completion of another pending operation.
+     */
+    save(nDelayInMilliseconds: int): Promise<any>;
+    /**
+     * @since 1.120.0
+     *
+     * Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
+     * In case it is not existing a new item with this key and value is created. The value is serialized during
+     * set
+     */
+    setItemValue(
+      /**
+       * item key. The string length is restricted to 40 characters
+       */
+      sItemKey: string,
+      /**
+       * item value (JSON object)
+       */
+      oItemValue: object
+    ): void;
   }
 }
 
@@ -7381,6 +7492,36 @@ declare module "sap/ushell/services/PersonalizationV2/Personalizer" {
      * To be called by the personalization service getPersonalizer method.
      */
     constructor();
+
+    /**
+     * @since 1.120.0
+     *
+     * Deletes a personalization data value.
+     *
+     * @returns Resolves if delete was successful
+     */
+    deletePersData(): Promise<any>;
+    /**
+     * @since 1.120.0
+     *
+     * Gets a personalization data value.
+     *
+     * @returns Resolves the data
+     */
+    getPersData(): Promise<object>;
+    /**
+     * @since 1.120.0
+     *
+     * Sets a personalization data value.
+     *
+     * @returns Resolves if save was successful
+     */
+    setPersData(
+      /**
+       * JSON object containing the personalization value.
+       */
+      oValue: object
+    ): Promise<any>;
   }
 }
 
@@ -7393,6 +7534,36 @@ declare module "sap/ushell/services/PersonalizationV2/TransientPersonalizer" {
    */
   export default class TransientPersonalizer {
     constructor();
+
+    /**
+     * @since 1.120.0
+     *
+     * Deletes a personalization data value.
+     *
+     * @returns Resolves if delete was successful.
+     */
+    deletePersData(): Promise<any>;
+    /**
+     * @since 1.120.0
+     *
+     * Gets a personalization data value.
+     *
+     * @returns Resolves the data.
+     */
+    getPersData(): Promise<object>;
+    /**
+     * @since 1.120.0
+     *
+     * Sets a personalization data value.
+     *
+     * @returns Resolves if save was successful.
+     */
+    setPersData(
+      /**
+       * JSON object containing the personalization value.
+       */
+      oValue: object
+    ): Promise<any>;
   }
 }
 
@@ -7405,13 +7576,220 @@ declare module "sap/ushell/services/PersonalizationV2/Variant" {
    */
   export default class Variant {
     /**
-     * To be instantiated via Personalization.VariantSet add / get Variant only
+     * To be instantiated via PersonalizationV2.VariantSet add / get Variant only
      */
     constructor();
+
+    /**
+     * @since 1.120.0
+     *
+     * Checks if a specific item is contained in this variant.
+     *
+     * @returns `true` if the variant contains an item with the key
+     */
+    containsItem(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): boolean;
+    /**
+     * @since 1.120.0
+     *
+     * Deletes an item from this variant. In case the item does not exist, nothing happens.
+     */
+    deleteItem(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): void;
+    /**
+     * @since 1.120.0
+     *
+     * Returns an array with the keys of all items in this variant.
+     *
+     * @returns item keys
+     */
+    getItemKeys(): string[];
+    /**
+     * @since 1.120.0
+     *
+     * Returns the value for an item in this variant.
+     *
+     * @returns item value (JSON object). In case the variant does not contain an item with this key `undefined`
+     * is returned.
+     */
+    getItemValue(
+      /**
+       * item key
+       */
+      sItemKey: string
+    ): object;
+    /**
+     * @since 1.120.0
+     *
+     * Returns the key of this variant.
+     *
+     * @returns variant key.
+     */
+    getVariantKey(): string;
+    /**
+     * @since 1.120.0
+     *
+     * Returns the name of this variant.
+     *
+     * @returns variant name.
+     */
+    getVariantName(): string;
+    /**
+     * @since 1.120.0
+     *
+     * Sets the value for an item in this variant.
+     */
+    setItemValue(
+      /**
+       * item key
+       */
+      sItemKey: string,
+      /**
+       * value (JSON object)
+       */
+      oItemValue: object
+    ): void;
+    /**
+     * @since 1.120.0
+     *
+     * Sets the name of the variant.
+     *
+     * In case a variant with `sVariantName` is already existing in the corresponding variant set an exception
+     * is thrown.
+     */
+    setVariantName(
+      /**
+       * variant name
+       */
+      sVariantName: string
+    ): void;
+  }
+}
+
+declare module "sap/ushell/services/PersonalizationV2/VariantSet" {
+  import Variant from "sap/ushell/services/PersonalizationV2/Variant";
+
+  /**
+   * @since 1.120.0
+   *
+   * The personalization variant set contains variants of personalization data. It is used in the personalization
+   * container mode.
+   */
+  export default class VariantSet {
+    /**
+     * A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
+     * variable indicating the "current variable"
+     *
+     * When manipulating the underlying data, additional constraints are enforced.
+     *
+     * To be called by the personalization container.
+     */
+    constructor();
+
+    /**
+     * @since 1.120.0
+     *
+     * Creates a new variant in the variant set. In case a variant with this name is already existing an exception
+     * is thrown.
+     */
+    addVariant(
+      /**
+       * variant set name
+       */
+      sVariantName: string
+    ): Variant;
+    /**
+     * @since 1.120.0
+     *
+     * Checks if a specific variant is contained in the variant set.
+     *
+     * @returns `true` if the variant set contains a variant with the key
+     */
+    containsVariant(
+      /**
+       * variant key
+       */
+      sVariantKey: string
+    ): boolean;
+    /**
+     * @since 1.120.0
+     *
+     * Deletes a variant from the variant set. In case the variant does not exist nothing happens.
+     */
+    deleteVariant(
+      /**
+       * variant key
+       */
+      sVariantKey: string
+    ): void;
+    /**
+     * @since 1.120.0
+     *
+     * Returns the current variant key.
+     *
+     * @returns current variant key. In case the current variant was never set `null` is returned.
+     */
+    getCurrentVariantKey(): string;
+    /**
+     * @since 1.120.0
+     *
+     * Returns a variant object.
+     *
+     * @returns In case the variant set does not contain a variant with this key `undefined` is returned.
+     */
+    getVariant(
+      /**
+       * variant key
+       */
+      sVariantKey: string
+    ): Variant;
+    /**
+     * @since 1.120.0
+     *
+     * Returns the variant key corresponding to a variant name.
+     *
+     * @returns variant key. In case the variant set does not contain a variant with this name `undefined` is
+     * returned.
+     */
+    getVariantKeyByName(
+      /**
+       * variant name
+       */
+      sVariantName: string
+    ): string;
+    /**
+     * @since 1.120.0
+     *
+     * Returns an array with the keys of the variants in the variant set.
+     *
+     * @returns variant keys
+     */
+    getVariantKeys(): string[];
+    /**
+     * @since 1.120.0
+     *
+     * Sets the current variant key.
+     */
+    setCurrentVariantKey(
+      /**
+       * There is no validity check for the variant key.
+       */
+      sVariantKey: string
+    ): void;
   }
 }
 
 declare module "sap/ushell/services/PersonalizationV2/VariantSetAdapter" {
+  import VariantSet from "sap/ushell/services/PersonalizationV2/VariantSet";
+
   /**
    * @since 1.120.0
    *
@@ -7440,6 +7818,66 @@ declare module "sap/ushell/services/PersonalizationV2/VariantSetAdapter" {
        */
       oContextContainer: object
     );
+
+    /**
+     * @since 1.120.0
+     *
+     * Creates a new variant set in the container. In case a variant set with this key is already existing an
+     * exception is thrown.
+     *
+     * @returns The new VariantSet
+     */
+    addVariantSet(
+      /**
+       * variant set key
+       */
+      sVariantSetKey: string
+    ): VariantSet;
+    /**
+     * @since 1.120.0
+     *
+     * Checks if a specific variant set is contained in the container.
+     *
+     * @returns `true` if the container contains a variant set with the key
+     */
+    containsVariantSet(
+      /**
+       * variant set key
+       */
+      sVariantSetKey: string
+    ): boolean;
+    /**
+     * @since 1.120.0
+     *
+     * Deletes a variant set from the container. In case the variant set does not exist nothing happens.
+     */
+    deleteVariantSet(
+      /**
+       * variant set key
+       */
+      sVariantSetKey: string
+    ): void;
+    /**
+     * @since 1.120.0
+     *
+     * Returns the variant set object from the container.
+     *
+     * @returns In case the container does not contain a variant set with this key `undefined` is returned.
+     */
+    getVariantSet(
+      /**
+       * variant set key. The string length is restricted to 40 characters.
+       */
+      sVariantSetKey: string
+    ): VariantSet;
+    /**
+     * @since 1.120.0
+     *
+     * Returns an array with the keys of the variant sets in the container.
+     *
+     * @returns variant set keys
+     */
+    getVariantSetKeys(): string[];
   }
 }
 
@@ -12225,6 +12663,8 @@ declare namespace sap {
 
     "sap/ushell/services/PersonalizationV2/Variant": undefined;
 
+    "sap/ushell/services/PersonalizationV2/VariantSet": undefined;
+
     "sap/ushell/services/PersonalizationV2/VariantSetAdapter": undefined;
 
     "sap/ushell/services/SearchableContent": undefined;
@@ -12243,6 +12683,8 @@ declare namespace sap {
 
     "sap/ushell/services/UserInfo": undefined;
 
+    "sap/ushell/services/UserRecents": undefined;
+
     "sap/ushell/services/VisualizationInstantiation": undefined;
 
     "sap/ushell/System": undefined;

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.4
+// For Library Version: 1.120.6
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.3
+// For Library Version: 1.120.6
 
 declare module "sap/uxap/library" {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.3
+// For Library Version: 1.120.6
 
 declare module "sap/viz/library" {
   export namespace ui5 {

package/types/sap.zen.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.0
+// For Library Version: 1.120.2
 
 declare module "sap/zen/commons/library" {}
 

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.0
+// For Library Version: 1.120.2
 
 declare module "sap/zen/crosstab/library" {}
 

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.0
+// For Library Version: 1.120.2
 
 declare module "sap/zen/dsh/library" {}