Module com.github.copilot.sdk.java
Package com.github.copilot.sdk.json

Class InputOptions

java.lang.Object
com.github.copilot.sdk.json.InputOptions
public class InputOptions extends Object
Options for the SessionUiApi.input(String, InputOptions) convenience method.
Since:
1.0.0

  • Constructor Details

    • InputOptions

      public InputOptions()

  • Method Details

    • getTitle

      public String getTitle()
      Gets the title label for the input field. @return the title

    • setTitle

      public InputOptions setTitle(String title)
      Sets the title label for the input field. @param title the title @return this

    • getDescription

      public String getDescription()
      Gets the descriptive text shown below the field. @return the description

    • setDescription

      public InputOptions setDescription(String description)
      Sets the descriptive text shown below the field. @param description the description @return this

    • getMinLength

      public OptionalInt getMinLength()
      Gets the minimum character length.
      Returns:
      an OptionalInt containing the min length, or OptionalInt.empty() if not set

    • setMinLength

      public InputOptions setMinLength(int minLength)
      Sets the minimum character length. @param minLength the min length @return this

    • clearMinLength

      public InputOptions clearMinLength()
      Clears the minLength setting, reverting to the default behavior.
      Returns:
      this instance for method chaining

    • getMaxLength

      public OptionalInt getMaxLength()
      Gets the maximum character length.
      Returns:
      an OptionalInt containing the max length, or OptionalInt.empty() if not set

    • setMaxLength

      public InputOptions setMaxLength(int maxLength)
      Sets the maximum character length. @param maxLength the max length @return this

    • clearMaxLength

      public InputOptions clearMaxLength()
      Clears the maxLength setting, reverting to the default behavior.
      Returns:
      this instance for method chaining

    • getFormat

      public String getFormat()
      Gets the semantic format hint (e.g., "email", "uri", "date", "date-time").
      Returns:
      the format hint

    • setFormat

      public InputOptions setFormat(String format)
      Sets the semantic format hint. @param format the format @return this

    • getDefaultValue

      public String getDefaultValue()
      Gets the default value pre-populated in the field. @return the default value

    • setDefaultValue

      public InputOptions setDefaultValue(String defaultValue)
      Sets the default value pre-populated in the field. @param defaultValue the default value @return this