Skip to content

Wire v1 tables (generated)

Parameters come from the JSON Schemas in ../v1/schemas/ (generated from the Rust serde types); result members and golden errors come from the runtime golden ../v1/conformance/golden.json (342 cases, host 1.0.3, headless; native GUI behavior is qualified separately). The golden records the JSON kind of each top-level member of the results it observed; members that only appear in other situations (or on a native desktop) are not listed. The schemas and the golden are the source of truth; the protocol reference explains semantics.

Regenerate with python3 scripts/docs/generate-wire-tables.py (--check verifies).

Client → host methods

Method Params Result members (golden) Golden errors
app.force_quit params not decoded (any object or omitted) — —
app.ready params not decoded (any object or omitted) ready boolean again → -32008; before_window → -32008
app.request_quit params not decoded (any object or omitted) requested boolean —
bitmap.close window_id: string (required)
document_id: string (required)
bitmap_id: string (required)
closed boolean —
bitmap.create window_id: string (required)
document_id: string (required)
bitmap_id: string (required)
width: integer ≥0 (required)
height: integer ≥0 (required)
slots: integer ≥0 (optional, default 2)
pixel_format: string (optional, default "RGBA8")
bitmap_id string, height number, owner string, path string, pixel_format string, slot_bytes number, slots number, stride number, width number bad_format → -32602
bitmap.present window_id: string (required)
document_id: string (required)
bitmap_id: string (required)
sequence: integer ≥0 (required)
slot: integer ≥0 (required)
presented_to_engine boolean, sequence number, slot_released boolean missing_member → -32602; sequence_zero → -32602; slot_out_of_bounds → -32602; unknown_bitmap → -32004; unknown_member → -32602
clipboard.read_text params not decoded (any object or omitted) — headless → -32001
clipboard.write_text text: string (required) — headless → -32001; unknown_member → -32602
desktop.open_external target: string (required)
window_id: string or null (optional)
— headless → -32001
desktop.paths params not decoded (any object or omitted) cache string, config string, data string, runtime string, state string —
desktop.preferences params not decoded (any object or omitted) available boolean, color_scheme null, high_contrast null, reduced_motion null, revision number, scope string, source string —
desktop.reveal_file path: string (required)
window_id: string or null (optional)
— relative_path → -32602
dialog.choose_folder window_id: string (required)
title: string or null (optional)
directory: string or null (optional)
file_name: string or null (optional)
filters: array of DialogFilter (optional, default [])
multiple: boolean (optional, default true)
— headless → -32001
dialog.open_files window_id: string (required)
title: string or null (optional)
directory: string or null (optional)
file_name: string or null (optional)
filters: array of DialogFilter (optional, default [])
multiple: boolean (optional, default true)
— headless → -32001; unknown_member → -32001
dialog.save_file window_id: string (required)
title: string or null (optional)
directory: string or null (optional)
file_name: string or null (optional)
filters: array of DialogFilter (optional, default [])
multiple: boolean (optional, default true)
— headless → -32001
document.command window_id, document_id, command (one op object, see below) — missing_op → -32602; stale_document → -32004; unknown_op → -32602; unknown_outer_member → -32602
document.get window_id: string (required) asset_root null, document_id null/string, loaded boolean, pending_resources boolean, renderer string, source null, window_id string —
document.load window_id: string (required)
html: string or null (optional, default null)
path: string or null (optional, default null)
asset_root: string or null (optional, default null)
asset_root null/string, document_id string, loaded boolean, pending_resources boolean, renderer string, source null/string, window_id string asset_root_not_directory → -32602; both_sources → -32602; neither_source → -32602; oversize_html → -32005; path_directory → -32602; path_missing → -32002; unknown_member → -32602
document.unload window_id: string (required)
document_id: string (required)
document_id null, loaded boolean, window_id string again → -32004
host.capabilities params not decoded (any object or omitted) accessibility boolean, capability_schema number, clipboard_text boolean, containment string, css_profile string, drag_drop boolean, external_open boolean, features object, file_dialogs boolean, headless boolean, html_css boolean, ime boolean, legacy_flags string, limits object, max_documents number, max_windows number, native boolean, native_preferences object, native_qualification string, platform string, printing boolean, probe boolean, qualification object, renderer string, tray boolean, window_positioning boolean, windows boolean —
host.diagnostics params not decoded (any object or omitted) backend_pid number, containment string, dropped_notifications number, logging object, pending_jobs number, pending_transfers number, phase string, pid number, windows array —
host.hello token: string (required)
protocol_version: any (required)
client: any (optional)
hand-validated: token (string), protocol_version (1); other members ignored
— —
probe.get_text window_id: string (required) anchor number, cursor number, focused boolean, preedit string, text string —
probe.set_text window_id: string (required)
text: string (required)
updated boolean —
request.cancel id: string (required) cancelled boolean missing_member → -32602
window.create title: string (optional, default "")
width: integer ≥0 (optional, default 900)
height: integer ≥0 (optional, default 560)
visible: boolean (optional, default true)
resizable: boolean (optional, default true)
decorations: boolean (optional, default true)
min_width: integer ≥0 or null (optional)
min_height: integer ≥0 or null (optional)
max_width: integer ≥0 or null (optional)
max_height: integer ≥0 or null (optional)
closing boolean, height number, native boolean, observed object, physical_size null, requested object, scale_factor number, title string, visible boolean, width number, window_id string unknown_member → -32602; wrong_type → -32602
window.get window_id: string (required) closing boolean, height number, native boolean, observed object, physical_size null, requested object, scale_factor number, title string, visible boolean, width number, window_id string missing_member → -32602; unknown_member → -32602; unknown_window → -32004
window.list params not decoded (any object or omitted) array —
window.request_attention window_id: string (required)
kind: string or null (optional)
— ok → -32001
window.request_close window_id: string (required) requested boolean —
window.set window_id: string (required)
title: string or null (optional)
width: integer ≥0 or null (optional)
height: integer ≥0 or null (optional)
visible: boolean or null (optional)
resizable: boolean or null (optional)
decorations: boolean or null (optional)
minimized: boolean or null (optional)
maximized: boolean or null (optional)
fullscreen: boolean or null (optional)
focus: boolean or null (optional)
x: integer or null (optional)
y: integer or null (optional)
min_width: integer ≥0 or null (optional, default null)
min_height: integer ≥0 or null (optional, default null)
max_width: integer ≥0 or null (optional, default null)
max_height: integer ≥0 or null (optional, default null)
closing boolean, height number, native boolean, observed object, physical_size null, requested object, scale_factor number, title string, visible boolean, width number, window_id string unknown_member → -32602

Secondary launcher → host

Method Params
app.activate any JSON object up to 32 KiB, forwarded verbatim as app.activated params

Host → client messages

Method Kind Params Reply
app.activated notification <secondary launcher payload> —
app.before_quit request reason allow: boolean (missing/false/non-boolean = veto)
app.shutdown notification deadline_ms —
desktop.preferences_changed notification <native preferences snapshot> —
document.error notification window_id, document_id, message —
document.event notification window_id, document_id, event —
request.cancelled notification id, reason —
window.before_close request window_id, reason allow: boolean (missing/false/non-boolean = veto)
window.event notification window_id, type, ... —

document.command ops (81)

element is an HTML id; node is an opaque generation-checked node reference (node:…) returned by ops such as query_nodes and node_of.

Op Fields Result members (golden) Golden errors
add_class element: string (required)
name: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
add_stylesheet css: string (required) diagnostics array, sheet number missing_required → -32602; unknown_member → -32602
append_text element: string (required)
text: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
batch ops: array of BatchOp (required) updated boolean missing_required → -32602; unknown_member → -32602
blur element: string or null (optional, default null)
node: string or null (optional, default null)
updated boolean unknown_member → -32602
check_validity element: string (required) count number, invalid array, valid boolean missing_required → -32602; unknown_member → -32602
clear_selection none (unknown members ignored) updated boolean —
close_dialog element: string (required)
return_value: string or null (optional, default null)
updated boolean missing_required → -32602; unknown_member → -32602
copy_selection none (unknown members ignored) text string —
css_profile none (unknown members ignored) features array, version string —
edit_command command: string (required)
element: string or null (optional, default null)
node: string or null (optional, default null)
accepted boolean, clipboard_pending boolean missing_required → -32602; required_only → -32602; unknown_member → -32602
element_at_point x: number (required)
y: number (required)
element null, node string missing_required → -32602; unknown_member → -32602
explain element: string or null (optional, default null)
node: string or null (optional, default null)
property: string or null (optional, default null)
element string, properties array, reason string, schema number, status string required_only → -32602; unknown_member → -32602
focus element: string or null (optional, default null)
node: string or null (optional, default null)
updated boolean required_only → -32602; unknown_member → -32602
get_accessibility_tree none (unknown members ignored) tree object —
get_attribute element: string (required)
name: string (required)
value string missing_required → -32602; unknown_member → -32602
get_attributes element: string (required) attributes object missing_required → -32602; unknown_member → -32602
get_checked element: string (required) checked boolean missing_required → -32602; unknown_member → -32602
get_computed_style element: string or null (optional, default null)
node: string or null (optional, default null)
properties: array of string (required)
properties object, schema number missing_required → -32602; required_only → -32602; unknown_member → -32602
get_control_selection element: string or null (optional, default null)
node: string or null (optional, default null)
direction string, end number, length number, node string, start number required_only → -32602; unknown_member → -32602
get_diagnostics none (unknown members ignored) css_profile_version string, diagnostics array —
get_dialog element: string (required) modal boolean, open boolean, return_value string missing_required → -32602; unknown_member → -32602
get_environment none (unknown members ignored) color_scheme string, color_scheme_source string, high_contrast null, high_contrast_source string, reduced_motion string, reduced_motion_source string, scale number, system_color_scheme string, system_reduced_motion null —
get_files element: string (required) files array missing_required → -32602; unknown_member → -32602
get_focused_element none (unknown members ignored) element string, node string —
get_form_data element: string or null (optional, default null)
node: string or null (optional, default null)
submitter: string or null (optional, default null)
submitter_node: string or null (optional, default null)
entries array, submitter null required_only → -32602; unknown_member → -32602
get_html element: string or null (optional, default null)
node: string or null (optional, default null)
outer: boolean (optional, default false)
offset: integer ≥0 (optional, default 0)
limit: integer ≥0 or null (optional, default null)
html string, next_offset null, offset number, total_bytes number, truncated boolean unknown_member → -32602
get_node node: string (required) attributes object, child_count number, id string, name string, next string, node string, parent string, previous string, type string missing_required → -32602; unknown_member → -32602
get_options element: string (required) options array missing_required → -32602; unknown_member → -32602
get_pointer_capture none (unknown members ignored) element null —
get_popover element: string (required) kind string, open boolean missing_required → -32602; unknown_member → -32602
get_rect element: string (required) rect object missing_required → -32602; unknown_member → -32602
get_resource_stats none (unknown members ignored) bundles object, cache object, svg_rasters object —
get_scroll element: string or null (optional, default null) animating boolean, height number, max_x number, max_y number, min_x number, min_y number, scrollable boolean, width number, x number, y number unknown_member → -32602
get_selection none (unknown members ignored) text string —
get_text element: string (required) text string missing_required → -32602; unknown_member → -32602
get_validity element: string (required) flags object, message string, valid boolean, will_validate boolean missing_required → -32602; unknown_member → -32602
get_value element: string (required) value string missing_required → -32602; unknown_member → -32602
has_element element: string (required) exists boolean missing_required → -32602; unknown_member → -32602
hide_popover element: string (required) updated boolean missing_required → -32602; unknown_member → -32602
insert_html element: string (required)
position: string (required)
html: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
list_stylesheets none (unknown members ignored) sheets array —
move_element element: string (required)
target: string (required)
position: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
node_batch ops: array of NodeBatchOp (required) updated boolean missing_required → -32602; unknown_member → -32602
node_children node: string (required)
offset: integer ≥0 (optional, default 0)
limit: integer ≥0 (optional, default 256)
children array, total number missing_required → -32602; unknown_member → -32602
node_of element: string or null (optional, default null) node string unknown_member → -32602
purge_unused_resources url: string or null (optional, default null) purged number, stats object unknown_member → -32602
query selector: string (required)
limit: integer ≥0 (optional, default 1024)
offset: integer ≥0 (optional, default 0)
ids array, limit number, matched_nodes number, offset number, total number, truncated boolean missing_required → -32602; unknown_member → -32602
query_nodes selector: string (required)
offset: integer ≥0 (optional, default 0)
limit: integer ≥0 (optional, default 1024)
nodes array, offset number, total number missing_required → -32602; unknown_member → -32602
register_resource_bundle name: string (required)
entries: array of ResourceEntry (required)
name string, replaced boolean missing_required → -32602; unknown_member → -32602
remove_attribute element: string (required)
name: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
remove_class element: string (required)
name: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
remove_element element: string (required) updated boolean missing_required → -32602; unknown_member → -32602
remove_stylesheet sheet: integer ≥0 (required) updated boolean missing_required → -32602; unknown_member → -32602
replace_children_html element: string (required)
html: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
replace_control_range element: string or null (optional, default null)
node: string or null (optional, default null)
replacement: string (required)
start: integer ≥0 or null (optional, default null)
end: integer ≥0 or null (optional, default null)
selection_mode: string (optional, default "preserve")
changed boolean, direction string, end number, length number, node string, start number missing_required → -32602; required_only → -32602; unknown_member → -32602
replace_stylesheet sheet: integer ≥0 (required)
css: string (required)
diagnostics array, sheet number missing_required → -32602; unknown_member → -32602
request_submit element: string or null (optional, default null)
node: string or null (optional, default null)
submitter: string or null (optional, default null)
submitter_node: string or null (optional, default null)
default_prevented boolean, submitted boolean required_only → -32602; unknown_member → -32602
reset_form element: string or null (optional, default null)
node: string or null (optional, default null)
default_prevented boolean, reset boolean required_only → -32602; unknown_member → -32602
scroll_by element: string or null (optional, default null)
dx: number (optional, default empty)
dy: number (optional, default empty)
behavior: string or null (optional, default null)
animating boolean, height number, max_x number, max_y number, min_x number, min_y number, scrollable boolean, width number, x number, y number unknown_member → -32602
scroll_into_view element: string (required)
block: string (optional, default "nearest")
inline: string (optional, default "nearest")
behavior: string or null (optional, default null)
updated boolean missing_required → -32602; unknown_member → -32602
scroll_to element: string or null (optional, default null)
x: number or null (optional, default null)
y: number or null (optional, default null)
behavior: string or null (optional, default null)
animating boolean, height number, max_x number, max_y number, min_x number, min_y number, scrollable boolean, width number, x number, y number unknown_member → -32602
select_text element: string or null (optional, default null) updated boolean unknown_member → -32602
set_attribute element: string (required)
name: string (required)
value: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
set_checked element: string (required)
checked: boolean (required)
updated boolean missing_required → -32602; unknown_member → -32602
set_control_selection element: string or null (optional, default null)
node: string or null (optional, default null)
start: integer ≥0 (required)
end: integer ≥0 (required)
direction: string (optional, default "none")
direction string, end number, length number, node string, start number missing_required → -32602; required_only → -32602; unknown_member → -32602
set_custom_validity element: string or null (optional, default null)
node: string or null (optional, default null)
message: string (required)
flags object, message string, valid boolean missing_required → -32602; required_only → -32602; unknown_member → -32602
set_default_action element: string (required)
event: string (required)
key: string or null (optional, default null)
shift: boolean or null (optional, default null)
ctrl: boolean or null (optional, default null)
alt: boolean or null (optional, default null)
meta: boolean or null (optional, default null)
prevent: boolean (optional, default true)
updated boolean missing_required → -32602; unknown_member → -32602
set_environment color_scheme: string or null (optional, default null)
reduced_motion: string or null (optional, default null)
color_scheme string, color_scheme_source string, high_contrast null, high_contrast_source string, reduced_motion string, reduced_motion_source string, scale number, system_color_scheme string, system_reduced_motion null unknown_member → -32602
set_pointer_capture element: string (required)
pointer_id: integer ≥0 (optional, default 1)
capture: boolean (optional, default true)
accepted boolean missing_required → -32602; unknown_member → -32602
set_scroll_follow element: string or null (optional, default null)
follow: boolean (optional, default true)
updated boolean unknown_member → -32602
set_selected_values element: string (required)
values: array of string (required)
updated boolean missing_required → -32602; unknown_member → -32602
set_text element: string (required)
text: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
set_value element: string (required)
value: string (required)
updated boolean missing_required → -32602; unknown_member → -32602
show_dialog element: string (required)
modal: boolean (optional, default true)
updated boolean missing_required → -32602; unknown_member → -32602
show_popover element: string (required) updated boolean missing_required → -32602; unknown_member → -32602
text_at_point x: number (required)
y: number (required)
hit object missing_required → -32602; unknown_member → -32602
text_rects element: string or null (optional, default null)
node: string or null (optional, default null)
start: integer ≥0 or null (optional, default null)
end: integer ≥0 or null (optional, default null)
length number, rects array, text string unknown_member → -32602
toggle_popover element: string (required) open boolean missing_required → -32602; unknown_member → -32602
trim_children element: string (required)
keep: integer ≥0 (required)
from: string (optional, default "start")
updated boolean missing_required → -32602; unknown_member → -32602
unregister_resource_bundle name: string (required) name string, removed boolean missing_required → -32602; unknown_member → -32602

BatchOp (items of batch.ops)

op Fields
set_text element: string (required)
text: string (required)
set_attribute element: string (required)
name: string (required)
value: string (required)
remove_attribute element: string (required)
name: string (required)
add_class element: string (required)
name: string (required)
remove_class element: string (required)
name: string (required)
insert_html element: string (required)
position: string (required)
html: string (required)
replace_children_html element: string (required)
html: string (required)
remove_element element: string (required)
move_element element: string (required)
target: string (required)
position: string (required)
append_text element: string (required)
text: string (required)
trim_children element: string (required)
keep: integer ≥0 (required)
from: string (optional, default "start")

NodeBatchOp (items of node_batch.ops)

op Fields
set_text node: string (required)
text: string (required)
set_attribute node: string (required)
name: string (required)
value: string (required)
remove_attribute node: string (required)
name: string (required)
add_class node: string (required)
name: string (required)
remove_class node: string (required)
name: string (required)
insert_html node: string (required)
position: string (required)
html: string (required)
replace_children_html node: string (required)
html: string (required)
remove_element node: string (required)
move_element node: string (required)
target_node: string (required)
position: string (required)
append_text node: string (required)
text: string (required)
trim_children node: string (required)
keep: integer ≥0 (required)
from: string (optional, default "start")

ResourceEntry (items of register_resource_bundle.entries)

Fields
path: string (required)
data_url: string (required)

Source: nativehtmlkit-core/protocol/reference/wire-tables.md · edit the page there.