Interface IPromptTextAnswerDescriptorBuilder


  • public interface IPromptTextAnswerDescriptorBuilder
    Builder for the text answer descriptor of a prompt query. Creates a record value descriptor with a single text property named "answer".
    Since:
    8.5.0
    • Method Detail

      • answerKey

        @CanIgnoreReturnValue
        IPromptTextAnswerDescriptorBuilder answerKey​(String answerKey)
        Sets the key for the single text property that contains the answer. Defaults to "answer".
        Parameters:
        answerKey - The key for the answer property.
        Returns:
        This builder for chaining method calls.
      • appendTo

        void appendTo​(IRecordValueDescriptorBuilder builder)
        Appends the properties to the given builder, using the current settings.
        Parameters:
        builder - The builder to append to.
      • build

        IValueDescriptor<?,​?> build()
        Creates a value descriptor for the text answer with the current settings.
        Returns:
        A new value descriptor.
      • builder

        IValueDescriptorBuilder<?,​?,​?> builder()
        Creates a value descriptor builder, preconfigured with the current settings, for the text answer descriptor. Useful if you want to further customize the descriptor.
        Returns:
        A new value descriptor builder.
      • descriptionMessageKey

        @CanIgnoreReturnValue
        IPromptTextAnswerDescriptorBuilder descriptionMessageKey​(String descriptionMessageKey)
        Sets the message key for the description of the property.
        Parameters:
        descriptionMessageKey - The message key for the description.
        Returns:
        This builder for chaining method calls.
      • labelMessageKey

        @CanIgnoreReturnValue
        IPromptTextAnswerDescriptorBuilder labelMessageKey​(String labelMessageKey)
        Sets the message key for the label of the property.
        Parameters:
        labelMessageKey - The message key for the label.
        Returns:
        This builder for chaining method calls.
      • recordBuilder

        IRecordValueDescriptorBuilder recordBuilder()
        Builds the value descriptor for the text answer property, then creates a record value descriptor builder with a single answer property. Useful if you want to further customize the descriptor.
        Returns:
        A new value descriptor builder.