Package com.github.copilot.sdk.json

Class ElicitationParams

java.lang.Object

com.github.copilot.sdk.json.ElicitationParams

public class ElicitationParams
extends Object

Parameters for an elicitation request sent from the SDK to the host.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ElicitationParams()

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Gets the message describing what information is needed from the user.
ElicitationSchema	getRequestedSchema()	Gets the JSON Schema describing the form fields to present.
ElicitationParams	setMessage(String message)	Sets the message describing what information is needed from the user.
ElicitationParams	setRequestedSchema(ElicitationSchema requestedSchema)	Sets the JSON Schema describing the form fields to present.

Methods inherited from class java.lang.Object

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

Constructor Details

ElicitationParams

public ElicitationParams()

Method Details

getMessage

public String getMessage()

Gets the message describing what information is needed from the user.

Returns:

the message

setMessage

public ElicitationParams setMessage(String message)

Sets the message describing what information is needed from the user.

Parameters:

message - the message

Returns:

this instance for method chaining

getRequestedSchema

public ElicitationSchema getRequestedSchema()

Gets the JSON Schema describing the form fields to present.

Returns:

the requested schema

setRequestedSchema

public ElicitationParams setRequestedSchema(ElicitationSchema requestedSchema)

Sets the JSON Schema describing the form fields to present.

Parameters:

requestedSchema - the schema

Returns:

this instance for method chaining