jmapcloud-ng-core-types 2.0.14-qa.1 → 2.0.14-qa.3

package/index.d.ts

@@ -33,6 +33,7 @@ export interface JCoreService extends JCoreMainService {
   Layer: JLayerService
   User: JUserService
   Language: JLanguageService
+  Message: JAppMessageService
   Feature: JFeatureService
   Map: JMapService
   Geocoding: JGeocodingService

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "2.0.14-qa.1",
+  "version": "2.0.14-qa.3",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",

package/public/core.d.ts

@@ -221,6 +221,89 @@ export namespace JMap {
    * ```
    */
   function getOS(): JOPERATING_SYSTEMS
+  /**
+   * **JMap.Message**
+   *
+   * You can manage application messages here.
+   */
+  namespace Message {
+    /**
+     * ***JMap.Message.error***
+     *
+     * Adds an error message in the application message stack for the current session.
+     *
+     * @param message the text of the message
+     * @param options a JAppMessageOptions object
+     */
+    function error(message: string, options?: JAppMessageOptions): void
+
+    /**
+     * ***JMap.Message.warning***
+     *
+     * Adds a warning message in the application message stack for the current session.
+     *
+     * @param message the text of the message
+     * @param options a JAppMessageOptions object
+     */
+    function warning(message: string, options?: JAppMessageOptions): void
+
+    /**
+     * ***JMap.Message.info***
+     *
+     * Adds an info message in the application message stack for the current session.
+     *
+     * @param message the text of the message
+     * @param options a JAppMessageOptions object
+     */
+    function info(message: string, options?: JAppMessageOptions): void
+
+    /**
+     * ***JMap.Message.success***
+     *
+     * Adds a success message in the application message stack for the current session.
+     *
+     * @param message the text of the message
+     * @param options a JAppMessageOptions object
+     */
+    function success(message: string, options?: JAppMessageOptions): void
+
+    /**
+     * ***JMap.Message.confirmMessage***
+     *
+     * Prompts a confirmation dialog message on the screen.
+     *
+     * @param params message parameters
+     */
+    function confirmMessage(params: JAppConfirmMessage): void
+
+    /**
+     * ***JMap.Message.display***
+     *
+     * Adds a generic message in the application message stack for the current session.
+     *
+     * @param message the text of the message
+     * @param options a JAppMessageOptions object
+     */
+    function display(message: string, options?: JAppMessageOptions): void
+
+    /**
+     * ***JMap.Message.displayWaitingOverlay***
+     *
+     * Opens an overlay panel that displays your message and a loading bar.
+     *
+     * @param message the text to show in the overlay
+     */
+    function displayWaitingOverlay(message: string): string
+
+    /**
+     * ***JMap.Message.closeWaitingOverlay***
+     *
+     * Closes one waiting overlay by id, or all of them when called without params.
+     *
+     * @param messageId optional waiting overlay id
+     */
+    function closeWaitingOverlay(messageId?: string): void
+  }
   /* **JMap.Server**
    *
    * This is where you can find JMap Server relative methods