Adaptive Forms

Class: GuideResultObject

GuideResultObject

new GuideResultObject()

Class representing the result of GuideBridge API. This class provides API to access the result of the GuideBridge API and retrieve any error messages the API has thrown.

Since:
  • 6.0

Members

<readonly> errors :boolean

whether the API succeeded or failed.

The value of this property is true if the API succeeded, otherwise false. The getNextMessage API can be used to retrieve the error messages in case the value of this property is false.

Type:
  • boolean
Since:
  • 6.0

<readonly> data :*

data returned by GuideBridge API

The type of the data is specific to the API and documentation of that API provides more details about the data

Type:
  • *
Since:
  • 6.0

Methods

getNextMessage()

Returns the error message thrown by the GuideBridge API.

When a GuideBridge API fails, it throws an error message. This is indicated by the errors property. To get the errors, one has to call this API. The API can throw multiple errors and the user has to call this API until it returns null indicating no more errors.

Since:
  • 6.0
Returns:

object containing the error message

Type
GuideResultObject~ErrorMessage

Type Definitions

ErrorMessage

Error Message returned by GuideBridge API

Type:
  • object
Properties:
Name Type Argument Description
code number

Error Code
somExpression string <nullable>

Som Expression of the GuideNode the error is related to. It can be null if error is not related to a GuideNode. For example, server failure when submitting the form.
message string

User friendly message for the error.
See: