Message

About 1 min

class Message

Properties

the JSON-RPC method name

public readonly string $method

Type: string

the request parameters, structured rather than positional

public readonly array $params

Type: array

the request id, or null for a notification

public readonly mixed $id

Type: mixed

whether the message omitted id entirely

public readonly bool $isNotification

Type: bool

public __construct(string $method, array $params, mixed $id, bool $isNotification): void

Parameter	Type	Description
`$method`	string	the JSON-RPC method name
`$params`	array	the request parameters, structured rather than positional
`$id`	mixed	the request id, or null for a notification
`$isNotification`	bool	whether the message omitted `id` entirely

Parses a raw request body into a message.

public fromJSON(string $json): self

Returns: self

Parameter	Type	Description
`$json`	string	the raw request body

Returns the request metadata carried in params._meta.

public getMeta(): array

Returns: array

Returns the protocol version the request declares, if any.

public getProtocolVersion(): ?string

Returns: string

Wraps a handler's return value in a JSON-RPC success envelope.

public result(mixed $id, array $result, array $serverInfo): array

Returns: array

resultType and the server identity are applied here so individual handlers never deal with the envelope.

Parameter	Type	Description
`$id`	mixed	the id of the request being answered
`$result`	array	the result payload
`$serverInfo`	array	the server name and version

Builds a JSON-RPC error envelope.

public error(mixed $id, int $code, string $message, mixed $data): array

Returns: array

Parameter	Type	Description
`$id`	mixed	the id of the request being answered, or null when it could not be read
`$code`	int	the JSON-RPC error code
`$message`	string	the error message
`$data`	mixed	optional structured payload

Generated by Hazaar API Doc Generator on Sun, 23 Aug 2026 10:49:44 +0000