Package com.github.copilot.sdk.json

Class ElicitationResult

java.lang.Object

com.github.copilot.sdk.json.ElicitationResult

public class ElicitationResult
extends Object

Result returned from an elicitation dialog.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ElicitationResult()

Method Summary

Modifier and Type	Method	Description
ElicitationResultAction	getAction()	Gets the user action taken on the elicitation dialog.
Map<String,Object>	getContent()	Gets the form values submitted by the user.
ElicitationResult	setAction(ElicitationResultAction action)	Sets the user action taken on the elicitation dialog.
ElicitationResult	setContent(Map<String,Object> content)	Sets the form values submitted by the user.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElicitationResult

public ElicitationResult()

Method Details

getAction

public ElicitationResultAction getAction()

Gets the user action taken on the elicitation dialog.

ElicitationResultAction.ACCEPT means the user submitted the form, ElicitationResultAction.DECLINE means the user rejected the request, and ElicitationResultAction.CANCEL means the user dismissed the dialog.

Returns:

the user action

setAction

public ElicitationResult setAction(ElicitationResultAction action)

Sets the user action taken on the elicitation dialog.

Parameters:

action - the user action

Returns:

this instance for method chaining

getContent

public Map<String,Object> getContent()

Gets the form values submitted by the user.

Only present when getAction() is ElicitationResultAction.ACCEPT.

Returns:

the submitted form values, or null if the user did not accept

setContent

public ElicitationResult setContent(Map<String,Object> content)

Sets the form values submitted by the user.

Parameters:

content - the submitted form values

Returns:

this instance for method chaining