From 6f06a7d9e7be6ad1116c8a0a08265c126ee8ff5d Mon Sep 17 00:00:00 2001 From: ci-build Date: Fri, 16 Feb 2024 09:26:09 +0000 Subject: [PATCH] [skip ci] jsdoc updates --- module-FormView-customFunctions.html | 416 +++++++-------------------- quicksearch.html | 2 +- 2 files changed, 109 insertions(+), 309 deletions(-) diff --git a/module-FormView-customFunctions.html b/module-FormView-customFunctions.html index ef9865d7a8..0c8d2b0e9f 100644 --- a/module-FormView-customFunctions.html +++ b/module-FormView-customFunctions.html @@ -105,7 +105,7 @@

-

Contains custom functions which can be used in the rule editor

+

Contains custom functions which can be used in the rule editor.

@@ -163,20 +163,17 @@

- - -

Methods

+

Members

-
-

<static> toObject(str)

- +
+

<static> toObject

+
-

Converts a JSON string to an object.

@@ -186,61 +183,6 @@

<static> - - - -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
str - - -string - - - - -

The JSON string to convert to an object.

- - - -
@@ -281,116 +223,82 @@
Parameters:
+
- + + +
+
+

<static> validateURL

- +
+
+ +
+

Validates if the given URL is correct.

+
-
Returns:
+
- -
-
    -
  • The parsed JSON object. Returns an empty object if an exception occurs.
    • -
-
- - - -
-
- Type -
-
- -object - - - -
-
+ - + - -
+ - - -
-
-

<static> externalize(url)

- -
-
-
-

Prefixes the URL with the context path.

-
- - - -
Parameters:
- + - - - - - - + - + - + - + - - - - - - - - - + - - + + + - - - +
+
+

<static> defaultErrorHandler

-
-
NameTypeDescription
url - - -string + + + + - -

The URL to externalize.

+ +
+ +
+

Default error handler for the invoke service API.

+
+ @@ -435,116 +343,82 @@
Parameters:
+
- + + +
+
+

<static> defaultSubmitSuccessHandler

- +
+
+ +
+

Handles the success response after a form submission.

+
-
Returns:
+
- -
-
    -
  • The externalized URL.
    • -
-
- + -
-
- Type -
-
- -string - - - -
-
- + - + -
- - -
-
-

<static> validateURL(url)

- -
-
-
-

Validates if the given URL is correct.

-
- - + - - -
Parameters:
- + - - - - - - + - + - + - - - - - - - - - - - + - - + + + - - - +
+
+

<static> defaultSubmitErrorHandler

-
-
NameTypeDescription
url - - -string + + + + - -

The URL to validate.

+ +
+ +
+

Handles the error response after a form submission.

+
+ @@ -589,51 +463,19 @@
Parameters:
+
+
+

Methods

- - - - - -
Returns:
- - -
-
    -
  • True if the URL is valid, false otherwise.
    • -
-
- - - -
-
- Type -
-
- -boolean - - - -
-
- - - - - - - - +
-

<static> navigateTo(destinationURL, destinationType)

+

<static> externalize(url)

@@ -641,7 +483,7 @@

<static> -

Navigates to the specified URL.

+

Prefixes the URL with the context path.

@@ -676,31 +518,7 @@

Parameters:
- destinationURL - - - - - -string - - - - - - - - - - -

The URL to navigate to. If not specified, a new blank window will be opened.

- - - - - - - destinationType + url @@ -717,7 +535,7 @@
Parameters:
-

The type of destination. Supports the following values: "_newwindow", "_blank", "_parent", "_self", "_top", or the name of the window.

+

The URL to externalize.

@@ -782,7 +600,7 @@
Returns:
@@ -794,7 +612,7 @@
Returns:
-Window +string @@ -811,7 +629,7 @@
Returns:
-

<static> defaultErrorHandler(response, headers, globals)

+

<static> navigateTo(destinationURL, destinationType)

@@ -819,7 +637,7 @@

<stat
-

Default error handler for the invoke service API.

+

Navigates to the specified URL.

@@ -854,37 +672,13 @@
Parameters:
- response - - - - - -object - - - - - - - - - - -

The response body of the invoke service API.

- - - - - - - headers + destinationURL -object +string @@ -895,20 +689,20 @@
Parameters:
-

The response headers of the invoke service API.

+

The URL to navigate to. If not specified, a new blank window will be opened.

- globals + destinationType -object +string @@ -919,7 +713,7 @@
Parameters:
-

An object containing form instance and invoke method to call other custom functions.

+

The type of destination. Supports the following values: "_newwindow", "_blank", "_parent", "_self", "_top", or the name of the window.

@@ -982,6 +776,12 @@
Parameters:
Returns:
+
+
    +
  • The newly opened window.
    • +
+
+
@@ -990,7 +790,7 @@
Returns:
-void +Window diff --git a/quicksearch.html b/quicksearch.html index 52e04f4c2a..c16ed3591e 100644 --- a/quicksearch.html +++ b/quicksearch.html @@ -7,7 +7,7 @@