PromptRecognizerResult<T> Class

Package:
com.microsoft.bot.dialogs.prompts
Maven Artifact:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.prompts.PromptRecognizerResult<T>

Type Parameters

T

The type of value the prompt returns.

public class PromptRecognizerResult<T>

Contains the result returned by the recognition method of a {@link Prompt{T}} .

Constructor Summary

Constructor Description
PromptRecognizerResult()

Initializes a new instance of the {@link PromptRecognizerResult{T}} class.

Method Summary

Modifier and Type Method and Description
java.lang.Boolean getAllowInterruption()

Gets a value indicating whether flag indicating whether or not parent dialogs should be allowed to interrupt the prompt.
java.lang.Boolean getSucceeded()

Gets a value indicating whether the recognition attempt succeeded.
T getValue()

Gets the recognition value.
void setAllowInterruption(Boolean allowInterruption)

Sets a value indicating whether flag indicating whether or not parent dialogs should be allowed to interrupt the prompt.
void setSucceeded(Boolean succeeded)

Sets a value indicating whether the recognition attempt succeeded.
void setValue(T value)

Sets the recogntion value.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

PromptRecognizerResult

public PromptRecognizerResult()

Initializes a new instance of the {@link PromptRecognizerResult{T}} class.

Method Details

getAllowInterruption

public Boolean getAllowInterruption()

Gets a value indicating whether flag indicating whether or not parent dialogs should be allowed to interrupt the prompt.

Returns:

The default value is false.

getSucceeded

public Boolean getSucceeded()

Gets a value indicating whether the recognition attempt succeeded.

Returns:

True if the recognition attempt succeeded; otherwise, false.

getValue

public T getValue()

Gets the recognition value.

Returns:

The recognition value.

setAllowInterruption

public void setAllowInterruption(Boolean allowInterruption)

Sets a value indicating whether flag indicating whether or not parent dialogs should be allowed to interrupt the prompt.

Parameters:

allowInterruption - The default value is false.

setSucceeded

public void setSucceeded(Boolean succeeded)

Sets a value indicating whether the recognition attempt succeeded.

Parameters:

succeeded - True if the recognition attempt succeeded; otherwise, false.

setValue

public void setValue(T value)

Sets the recogntion value.

Parameters:

value - Value to set the recognition value to.

Applies to