Package com.smartgwt.client.ai

Class BuildUIViaAIRequest

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.util.AsyncOperationParams
com.smartgwt.client.ai.BuildViaAIRequest
com.smartgwt.client.ai.BuildUIViaAIRequest
All Implemented Interfaces:
HasHandlers
Direct Known Subclasses:
BuildDataBoundUIViaAIRequest
public class BuildUIViaAIRequest extends BuildViaAIRequest
Represents a request to AI for UI elements.

  • Constructor Details

    • BuildUIViaAIRequest

      public BuildUIViaAIRequest()

    • BuildUIViaAIRequest

      public BuildUIViaAIRequest(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static BuildUIViaAIRequest getOrCreateRef(JavaScriptObject jsObj)

    • setAllowedUITypes

      public BuildUIViaAIRequest setAllowedUITypes(String... allowedUITypes)
      The list of allowed UI types.

      A "UI type" string is usually not the same as the corresponding Smart GWT component type name.

      Parameters:
      allowedUITypes - New allowedUITypes value. Default value is null
      Returns:
      BuildUIViaAIRequest instance, for chaining setter calls

    • getAllowedUITypes

      public String[] getAllowedUITypes()
      The list of allowed UI types.

      A "UI type" string is usually not the same as the corresponding Smart GWT component type name.

      Returns:
      Current allowedUITypes value. Default value is null

    • setCustomValidator

      public BuildUIViaAIRequest setCustomValidator(BuildUIViaAICustomValidator customValidator)
      The custom validation routine to use. If this validator is supplied, but "custom" is not included among the validationTypes, then it is implicitly assumed that custom validation will be performed last.
      Parameters:
      customValidator - New customValidator value. Default value is null
      Returns:
      BuildUIViaAIRequest instance, for chaining setter calls

    • setMaxValidationRetries

      public BuildUIViaAIRequest setMaxValidationRetries(Integer maxValidationRetries)
      The maximum numnber of re-attempts to have the AI fix a validation error.
      Parameters:
      maxValidationRetries - New maxValidationRetries value. Default value is 1
      Returns:
      BuildUIViaAIRequest instance, for chaining setter calls

    • getMaxValidationRetries

      public Integer getMaxValidationRetries()
      The maximum numnber of re-attempts to have the AI fix a validation error.
      Returns:
      Current maxValidationRetries value. Default value is 1

    • setUserAIRequest

      public BuildUIViaAIRequest setUserAIRequest(UserAIRequest userAIRequest)
      The request from the user describing what UI they would like the AI to build.
      Overrides:
      setUserAIRequest in class BuildViaAIRequest
      Parameters:
      userAIRequest - New userAIRequest value. Default value is null
      Returns:
      BuildUIViaAIRequest instance, for chaining setter calls

    • getUserAIRequest

      public UserAIRequest getUserAIRequest()
      The request from the user describing what UI they would like the AI to build.
      Overrides:
      getUserAIRequest in class BuildViaAIRequest
      Returns:
      Current userAIRequest value. Default value is null

    • setValidationTypes

      public BuildUIViaAIRequest setValidationTypes(BuildUIViaAIValidationType... validationTypes)
      The types of validation to use on AI-generated JS code, in the order in which they should be applied.
      Parameters:
      validationTypes - New validationTypes value. Default value is ["default"]
      Returns:
      BuildUIViaAIRequest instance, for chaining setter calls

    • getValidationTypes

      public BuildUIViaAIValidationType[] getValidationTypes()
      The types of validation to use on AI-generated JS code, in the order in which they should be applied.
      Returns:
      Current validationTypes value. Default value is ["default"]