From fd5f68774de240f96c85b0260b8ca08dd1073c65 Mon Sep 17 00:00:00 2001 From: permission-error Date: Wed, 18 Oct 2023 20:35:48 +0300 Subject: [PATCH 1/8] Document odksurvey.js funtionns --- odkx-src/injected-interfaces.rst | 267 +++++++++++++++++++++++++++++++ 1 file changed, 267 insertions(+) diff --git a/odkx-src/injected-interfaces.rst b/odkx-src/injected-interfaces.rst index a45dcc91..bf7871da 100644 --- a/odkx-src/injected-interfaces.rst +++ b/odkx-src/injected-interfaces.rst @@ -733,3 +733,270 @@ removeFirstQueuedAction ~~~~~~~~~~~~~~~~~~~~~~~~~~ Removes the first queued action. + +List of Available Methods in odkSurvey.js +---------------------------------------------------------- + +Here you will find a list of all available methods for you to use that can be found in :file:`system/js/odkSurvey.js`. + +isArray +~~~~~~~~ + + **Parameters** + + - varToTest: The variable to be tested for array type. + + **Returns**: Boolean value, `true` if the variable is an array, `false` otherwise. + +Checks if a given variable is an array and returns a boolean indicating whether it is an array or not. + +isString +~~~~~~~~~~~~~~ + + **Parameters** + + - str: The value to be checked for string type. + + **Returns**: Boolean value, true if the value is a string, false otherwise. + +Determines whether a given value is a string and returns a boolean value accordingly. + +getHashString +~~~~~~~~~~~~~~ + + **Parameters**: + + - tableId: The table ID that the survey is associated with. + - formId: The form ID for the survey. + - instanceId: The unique instance ID (optional). + - screenPath: The path to the specific screen or prompt. + - elementKeyToValueMap: A mapping of element keys to corresponding values (optional). + + **Returns**: A hash string for constructing a survey URI. + +Generates a hash string for constructing a survey URI. +This hash string is used for specifying the parameters required for survey navigation. + +getFormsProviderUri +~~~~~~~~~~~~~~~~~~~~ + + **Parameters**: + + - platInfo: Platform information, typically containing app-specific details. + - tableId: The table ID of the form. + - formId: The form ID. + + **Returns**: The forms provider URI. + +Constructs a forms provider URI for accessing specific forms within the ODK Survey app. + +convertHashStringToSurveyUri +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + **Parameters**: + + - hashString: The hash string to be converted. + + **Returns**: A complete survey URI for use in ODK Survey. + +Converts a hash string into a complete survey URI suitable for invoking ODK Survey. +This function is used to reformat hash strings for proper survey navigation. + +getFormPath +~~~~~~~~~~~~ + + **Parameters**: + + - tableId: The table ID associated with the form. + - formId: The form ID. + + **Returns**: The file path for the specified form. + +Retrieves the file path of a specific form based on the table and form IDs. This is used to locate the form's assets. + +openInstance +~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct: An optional parameter for dispatching actions or results. + - tableId: The table ID for the form. + - formId: The form ID. + - instanceId: The unique instance ID. + - initialValuesElementKeyToValueMap: A mapping of element keys to initial values for pre-filling form fields (optional). + + **Returns**: The result of the action, typically indicating whether the action was successful. + +Opens a new survey instance within the ODK Survey app, allowing users to start collecting data for a specific form. + +addInstance +~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - formId (String): The form ID. + - initialValuesElementKeyToValueMap (Object): A mapping of element keys to initial values for pre-filling form fields (optional). + + **Returns**: The result of the action, typically indicating whether the action was successful. + +Adds a new survey instance within the ODK Survey app, generating a new instance ID and allowing users to start data collection for a specific form. + +openLink +~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - relativeOrFullUrl (String): The URL to be opened. + + **Returns**: The result of the action, typically indicating whether the action was successful. + +Opens a link within the ODK Survey app, either using a relative or full URL, allowing for navigation to external web content or internal survey screens. + +fileAttachmentAction +~~~~~~~~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - intentAction (String): The intent action for the specific file attachment action. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the file attachment action, typically indicating whether the action was successful. + +Initiates file attachment actions such as capturing images, audio, or video, enabling users to attach files to a specific form instance. + +captureImage +~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the image capture action, typically indicating whether the action was successful. + +Initiates the action to capture an image, allowing users to take pictures and attach them to a specific form instance. + +captureSignature +~~~~~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the signature capture action, typically indicating whether the action was successful. + +Initiates the action to capture a signature, enabling users to create digital signatures and attach them to a specific form instance. + +captureAudio +~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the audio capture action, typically indicating whether the action was successful. + +Initiates the action to capture audio, allowing users to record audio clips and attach them to a specific form instance. + +captureVideo +~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the video capture action, typically indicating whether the action was successful. + +Initiates the action to capture video, allowing users to record video clips and attach them to a specific form instance. + +chooseImage +~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the image selection action, typically indicating whether the action was successful. + +Initiates the action to choose an image from the device's gallery or file system, allowing users to attach existing images to a specific form instance. + +chooseAudio +~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the audio file selection action, typically indicating whether the action was successful. + +Initiates the action to choose an audio file from the device's storage, allowing users to attach existing audio files to a specific form instance. + +chooseVideo +~~~~~~~~~~~~ + + **Parameters:** + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + - tableId (String): The table ID for the form. + - instanceId (String): The instance ID. + - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). + + **Returns**: The result of the video file selection action, typically indicating whether the action was successful. + +Initiates the action to choose a video from the device's storage, allowing users to attach existing videos to a specific form instance. + +scanBarcode +~~~~~~~~~~~~ + + **Parameters:** + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + + **Returns:** The result of the barcode scanning action. + +Initiates a barcode scanning action within the ODK Survey app, allowing users to scan barcodes for data collection. + +captureGeopoint +~~~~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + + **Returns**: The result of the geopoint capture action. + +Initiates a geopoint capture action within the ODK Survey app, enabling users to capture geographic coordinates (latitude and longitude). + +captureGeopointUsingMap +~~~~~~~~~~~~~~~~~~~~~~~~ + + **Parameters**: + + - dispatchStruct (Any): An optional parameter for dispatching actions or results. + + **Returns**: The result of the geopoint capture action using a map. + +Initiates a geopoint capture action using a map within the ODK Survey app, allowing users to select geographic coordinates interactively. From 63e16f8276152ed96ddaa4ccf7b8640aba5e5492 Mon Sep 17 00:00:00 2001 From: permission-error Date: Sat, 21 Oct 2023 09:41:44 +0300 Subject: [PATCH 2/8] Add spelling exceptions --- odkx-src/config-file-structure.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/odkx-src/config-file-structure.rst b/odkx-src/config-file-structure.rst index 7146343a..6ca17e25 100644 --- a/odkx-src/config-file-structure.rst +++ b/odkx-src/config-file-structure.rst @@ -57,3 +57,16 @@ A complementary description is provided in the user-level documentation. The too /output - holds logging files, exported data /permanent - available for device-only content (e.g., map tiles) +# Add spelling exceptions +spelling_word_list = [ + "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", + "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", + "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", + "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", + "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", + "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", + "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", + "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", + "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", + "captureGeopointUsingMap" +] From 4daf419081e33de8ca459d44a52469e0c788f35b Mon Sep 17 00:00:00 2001 From: permission-error Date: Sat, 21 Oct 2023 09:47:16 +0300 Subject: [PATCH 3/8] fix build --- odkx-src/config-file-structure.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/odkx-src/config-file-structure.rst b/odkx-src/config-file-structure.rst index 6ca17e25..45145fe7 100644 --- a/odkx-src/config-file-structure.rst +++ b/odkx-src/config-file-structure.rst @@ -58,15 +58,15 @@ A complementary description is provided in the user-level documentation. The too /permanent - available for device-only content (e.g., map tiles) # Add spelling exceptions -spelling_word_list = [ - "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", - "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", - "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", - "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", - "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", - "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", - "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", - "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", - "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", - "captureGeopointUsingMap" -] + spelling_word_list = [ + "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", + "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", + "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", + "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", + "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", + "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", + "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", + "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", + "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", + "captureGeopointUsingMap" + ] From 6a06a50c37c280948f0c45b37963d37d5b430187 Mon Sep 17 00:00:00 2001 From: permission-error Date: Sat, 21 Oct 2023 09:51:07 +0300 Subject: [PATCH 4/8] Fix build --- odkx-src/conf.py | 14 ++++++++++++++ odkx-src/config-file-structure.rst | 14 -------------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/odkx-src/conf.py b/odkx-src/conf.py index b950cbda..eaed9a57 100755 --- a/odkx-src/conf.py +++ b/odkx-src/conf.py @@ -400,3 +400,17 @@ def setup(app): 'github_version' : "master", # Version 'conf_py_path' : "/odkx-src/" # Path in the checkout to the docs root } + +# Add spelling exceptions +spelling_word_list = [ + "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", + "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", + "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", + "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", + "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", + "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", + "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", + "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", + "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", + "captureGeopointUsingMap" +] diff --git a/odkx-src/config-file-structure.rst b/odkx-src/config-file-structure.rst index 45145fe7..9fa5dc17 100644 --- a/odkx-src/config-file-structure.rst +++ b/odkx-src/config-file-structure.rst @@ -56,17 +56,3 @@ A complementary description is provided in the user-level documentation. The too /survey/templates/... -- `ODK-X Survey `_ handlebars templates /output - holds logging files, exported data /permanent - available for device-only content (e.g., map tiles) - -# Add spelling exceptions - spelling_word_list = [ - "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", - "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", - "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", - "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", - "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", - "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", - "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", - "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", - "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", - "captureGeopointUsingMap" - ] From bb2fe8d2c18bd819eb9a29eff612b54ea8746f01 Mon Sep 17 00:00:00 2001 From: permission-error Date: Sat, 21 Oct 2023 11:05:28 +0300 Subject: [PATCH 5/8] Remove spelling exceptions --- odkx-src/conf.py | 13 ------------- odkx-src/injected-interfaces.rst | 33 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/odkx-src/conf.py b/odkx-src/conf.py index eaed9a57..be69f316 100755 --- a/odkx-src/conf.py +++ b/odkx-src/conf.py @@ -401,16 +401,3 @@ def setup(app): 'conf_py_path' : "/odkx-src/" # Path in the checkout to the docs root } -# Add spelling exceptions -spelling_word_list = [ - "isArray", "varToTest", "getHashString", "getFormsProviderUri", "platInfo", - "convertHashStringToSurveyUri", "hashString", "getFormPath", "openInstance", - "initialValuesElementKeyToValueMap", "addInstance", "initialValuesElementKeyToValueMap", - "openLink", "relativeOrFullUrl", "fileAttachmentAction", "intentAction", - "existingFileAttachmentFieldContent", "captureImage", "existingFileAttachmentFieldContent", - "captureSignature", "existingFileAttachmentFieldContent", "captureAudio", - "existingFileAttachmentFieldContent", "captureVideo", "existingFileAttachmentFieldContent", - "chooseImage", "existingFileAttachmentFieldContent", "chooseAudio", "existingFileAttachmentFieldContent", - "chooseVideo", "existingFileAttachmentFieldContent", "scanBarcode", "captureGeopoint", - "captureGeopointUsingMap" -] diff --git a/odkx-src/injected-interfaces.rst b/odkx-src/injected-interfaces.rst index bf7871da..46d10394 100644 --- a/odkx-src/injected-interfaces.rst +++ b/odkx-src/injected-interfaces.rst @@ -117,6 +117,39 @@ Timestamp org reconstructive + isArray + varToTest + getHashString + getFormsProviderUri + platInfo + convertHashStringToSurveyUri + hashString + getFormPath + openInstance + initialValuesElementKeyToValueMap + addInstance + initialValuesElementKeyToValueMap + openLink + relativeOrFullUrl + fileAttachmentAction + intentAction + existingFileAttachmentFieldContent + captureImageexistingFileAttachmentFieldContent + captureSignature + existingFileAttachmentFieldContent + captureAudio + existingFileAttachmentFieldContent + captureVideo + existingFileAttachmentFieldContent + chooseImage + existingFileAttachmentFieldContent + chooseAudio + existingFileAttachmentFieldContent + chooseVideo + existingFileAttachmentFieldContent + scanBarcode + captureGeopoint + captureGeopointUsingMap ODK-X WebKit From 92d90662bebe1157b0d82886a5f4d8159f5d0950 Mon Sep 17 00:00:00 2001 From: permission-error Date: Sat, 21 Oct 2023 11:12:58 +0300 Subject: [PATCH 6/8] Fix spelling exceptions --- odkx-src/injected-interfaces.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/odkx-src/injected-interfaces.rst b/odkx-src/injected-interfaces.rst index 46d10394..d32f64c3 100644 --- a/odkx-src/injected-interfaces.rst +++ b/odkx-src/injected-interfaces.rst @@ -150,6 +150,7 @@ scanBarcode captureGeopoint captureGeopointUsingMap + captureImage ODK-X WebKit From 2a1ba9d2f61517e39cf76192033bfb9a52e2ab38 Mon Sep 17 00:00:00 2001 From: permission-error Date: Thu, 26 Oct 2023 00:09:11 +0300 Subject: [PATCH 7/8] Refactor docs --- odkx-src/injected-interfaces.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/odkx-src/injected-interfaces.rst b/odkx-src/injected-interfaces.rst index d32f64c3..a31659fc 100644 --- a/odkx-src/injected-interfaces.rst +++ b/odkx-src/injected-interfaces.rst @@ -822,7 +822,7 @@ getFormsProviderUri **Returns**: The forms provider URI. -Constructs a forms provider URI for accessing specific forms within the ODK Survey app. +Constructs a forms provider URI for accessing specific forms within the ODK-X Survey app. convertHashStringToSurveyUri ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -831,9 +831,9 @@ convertHashStringToSurveyUri - hashString: The hash string to be converted. - **Returns**: A complete survey URI for use in ODK Survey. + **Returns**: A complete survey URI for use in ODK-X Survey. -Converts a hash string into a complete survey URI suitable for invoking ODK Survey. +Converts a hash string into a complete survey URI suitable for invoking ODK-X Survey. This function is used to reformat hash strings for proper survey navigation. getFormPath @@ -861,7 +861,7 @@ openInstance **Returns**: The result of the action, typically indicating whether the action was successful. -Opens a new survey instance within the ODK Survey app, allowing users to start collecting data for a specific form. +Opens a new survey instance within the ODK-X Survey app, allowing users to start collecting data for a specific form. addInstance ~~~~~~~~~~~~ @@ -875,7 +875,7 @@ addInstance **Returns**: The result of the action, typically indicating whether the action was successful. -Adds a new survey instance within the ODK Survey app, generating a new instance ID and allowing users to start data collection for a specific form. +Adds a new survey instance within the ODK-X Survey app, generating a new instance ID and allowing users to start data collection for a specific form. openLink ~~~~~~~~~ @@ -887,7 +887,7 @@ openLink **Returns**: The result of the action, typically indicating whether the action was successful. -Opens a link within the ODK Survey app, either using a relative or full URL, allowing for navigation to external web content or internal survey screens. +Opens a link within the ODK-X Survey app, either using a relative or full URL, allowing for navigation to external web content or internal survey screens. fileAttachmentAction ~~~~~~~~~~~~~~~~~~~~ @@ -1011,7 +1011,7 @@ scanBarcode **Returns:** The result of the barcode scanning action. -Initiates a barcode scanning action within the ODK Survey app, allowing users to scan barcodes for data collection. +Initiates a barcode scanning action within the ODK-X Survey app, allowing users to scan barcodes for data collection. captureGeopoint ~~~~~~~~~~~~~~~~ @@ -1022,7 +1022,7 @@ captureGeopoint **Returns**: The result of the geopoint capture action. -Initiates a geopoint capture action within the ODK Survey app, enabling users to capture geographic coordinates (latitude and longitude). +Initiates a geopoint capture action within the ODK-X Survey app, enabling users to capture geographic coordinates (latitude and longitude). captureGeopointUsingMap ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1033,4 +1033,4 @@ captureGeopointUsingMap **Returns**: The result of the geopoint capture action using a map. -Initiates a geopoint capture action using a map within the ODK Survey app, allowing users to select geographic coordinates interactively. +Initiates a geopoint capture action using a map within the ODK-X Survey app, allowing users to select geographic coordinates interactively. From 9c6ae1c82894067aa738ec11d67a9c3c976a21dd Mon Sep 17 00:00:00 2001 From: permission-error Date: Thu, 2 Nov 2023 10:31:40 +0300 Subject: [PATCH 8/8] Add Instanceid description --- odkx-src/injected-interfaces.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/odkx-src/injected-interfaces.rst b/odkx-src/injected-interfaces.rst index a31659fc..b9c7022d 100644 --- a/odkx-src/injected-interfaces.rst +++ b/odkx-src/injected-interfaces.rst @@ -802,7 +802,7 @@ getHashString - tableId: The table ID that the survey is associated with. - formId: The form ID for the survey. - - instanceId: The unique instance ID (optional). + - instanceId: This parameter represents a unique instance ID. It is expected to be either a string or null. - screenPath: The path to the specific screen or prompt. - elementKeyToValueMap: A mapping of element keys to corresponding values (optional). @@ -856,7 +856,7 @@ openInstance - dispatchStruct: An optional parameter for dispatching actions or results. - tableId: The table ID for the form. - formId: The form ID. - - instanceId: The unique instance ID. + - instanceId: This parameter represents a unique instance ID. It is expected to be either a string or null. - initialValuesElementKeyToValueMap: A mapping of element keys to initial values for pre-filling form fields (optional). **Returns**: The result of the action, typically indicating whether the action was successful. @@ -897,7 +897,7 @@ fileAttachmentAction - dispatchStruct (Any): An optional parameter for dispatching actions or results. - intentAction (String): The intent action for the specific file attachment action. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the file attachment action, typically indicating whether the action was successful. @@ -911,7 +911,7 @@ captureImage - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the image capture action, typically indicating whether the action was successful. @@ -925,7 +925,7 @@ captureSignature - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the signature capture action, typically indicating whether the action was successful. @@ -939,7 +939,7 @@ captureAudio - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the audio capture action, typically indicating whether the action was successful. @@ -953,7 +953,7 @@ captureVideo - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the video capture action, typically indicating whether the action was successful. @@ -967,7 +967,7 @@ chooseImage - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the image selection action, typically indicating whether the action was successful. @@ -981,7 +981,7 @@ chooseAudio - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the audio file selection action, typically indicating whether the action was successful. @@ -995,7 +995,7 @@ chooseVideo - dispatchStruct (Any): An optional parameter for dispatching actions or results. - tableId (String): The table ID for the form. - - instanceId (String): The instance ID. + - instanceId (String): This parameter represents a unique instance ID. It is expected to be either a string or null. - existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional). **Returns**: The result of the video file selection action, typically indicating whether the action was successful.