ElicitRequest extends Request
FinalYes
A request from the server to elicit additional information from the user.
The client will present the message and requested schema to the user, allowing them to provide the requested information, decline, or cancel the operation.
Tags
Table of Contents
Properties
- $message : string
- $requestedSchema : ElicitationSchema
- $id : string|int
- $meta : array<string, mixed>|null
Methods
- __construct() : mixed
- fromArray() : static
- getId() : string|int
- getMeta() : array<string, mixed>|null
- getMethod() : string
- jsonSerialize() : RequestData
- withId() : static
- withMeta() : static
- fromParams() : static
- getParams() : ElicitationSchema}
Properties
$message read-only
public
string
$message
$requestedSchema read-only
public
ElicitationSchema
$requestedSchema
$id
protected
string|int
$id
$meta
protected
array<string, mixed>|null
$meta
= null
Methods
__construct()
public
__construct(string $message, ElicitationSchema $requestedSchema) : mixed
Parameters
- $message : string
-
A human-readable message describing what information is needed
- $requestedSchema : ElicitationSchema
-
The schema defining the fields to elicit from the user
fromArray()
public
static fromArray(RequestData $data) : static
Parameters
- $data : RequestData
Return values
staticgetId()
public
getId() : string|int
Return values
string|intgetMeta()
public
getMeta() : array<string, mixed>|null
Return values
array<string, mixed>|nullgetMethod()
public
static getMethod() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : RequestData
Return values
RequestDatawithId()
public
withId(string|int $id) : static
Parameters
- $id : string|int
Return values
staticwithMeta()
public
withMeta(array<string, mixed>|null $meta) : static
Parameters
- $meta : array<string, mixed>|null
Return values
staticfromParams()
protected
static fromParams(array<string|int, mixed>|null $params) : static
Parameters
- $params : array<string|int, mixed>|null
Return values
staticgetParams()
protected
getParams() : ElicitationSchema}