host.ui_services · class · Updated 2026-09-09

nativeUiHostReferenceProvider

A native ui host reference provider record carrying schema, schemaVersion, provider, capabilitySchema, capabilitySchemaVersion, and related state.

classcpuhosthost.ui_servicesmethodsource-exampleui_servicesyeho

Define host text, editing, clipboard, and accessibility service contracts.

external class nativeUiHostReferenceProvider

Status: source-declared

Fields and methods (93)

text schema: Stores schema as text.
int schemaVersion: Stores schema version as int.
text provider: Stores provider as text.
text capabilitySchema: Stores capability schema as text.
int capabilitySchemaVersion: Stores capability schema version as int.
text state: Stores state as text.
int ownerThread: Stores owner thread as int.
text diagnostic: Stores diagnostic as text.
int nextSequence: Stores next sequence as int.
int lastTimestamp: Stores last timestamp as int.
int lastCorrelation: Stores last correlation as int.
int failureCount: Stores failure count as int.
int allocationCount: Stores allocation count as int.
int maxLatencyMicroseconds: Stores max latency microseconds as int.
bool dispatching: Stores dispatching as bool.
bool accessibilityAvailable: Stores accessibility available as bool.
bool textInputAvailable: Stores text input available as bool.
bool clipboardAvailable: Stores clipboard available as bool.
bool displayAvailable: Stores display available as bool.
bool sessionAvailable: Stores session available as bool.
bool virtualKeyboardAvailable: Stores virtual keyboard available as bool.
bool delayedClipboardAvailable: Stores delayed clipboard available as bool.
int accessibilityBatchDepth: Stores accessibility batch depth as int.
list of text accessibilityNodeIds: Stores accessibility node ids as list of text.
list of int accessibilityGenerations: Stores accessibility generations as list of int.
list of text accessibilityRoles: Stores accessibility roles as list of text.
list of text accessibilityNames: Stores accessibility names as list of text.
text textWindow: Stores text window as text.
text preedit: Stores preedit as text.
text surroundingText: Stores surrounding text as text.
int selectionStart: Stores selection start as int.
int selectionLength: Stores selection length as int.
int replacementStart: Stores replacement start as int.
int replacementLength: Stores replacement length as int.
int caretX: Stores caret x as int.
int caretY: Stores caret y as int.
int caretWidth: Stores caret width as int.
int caretHeight: Stores caret height as int.
int candidateX: Stores candidate x as int.
int candidateY: Stores candidate y as int.
text inputPurpose: Stores input purpose as text.
text inputHints: Stores input hints as text.
bool compositionActive: Stores composition active as bool.
bool virtualKeyboardRequested: Stores virtual keyboard requested as bool.
bool virtualKeyboardVisible: Stores virtual keyboard visible as bool.
text clipboardOwner: Stores clipboard owner as text.
text clipboardFormat: Stores clipboard format as text.
text clipboardData: Stores clipboard data as text.
bool clipboardDelayed: Stores clipboard delayed as bool.
list of text displayIds: Stores display ids as list of text.
list of int displayX: Stores display x as list of int.
list of int displayY: Stores display y as list of int.
list of int displayWidth: Stores display width as list of int.
list of int displayHeight: Stores display height as list of int.
list of int displayWorkX: Stores display work x as list of int.
list of int displayWorkY: Stores display work y as list of int.
list of int displayWorkWidth: Stores display work width as list of int.
list of int displayWorkHeight: Stores display work height as list of int.
list of int displayScale: Stores display scale as list of int.
list of bool displayPrimary: Stores display primary as list of bool.
int topologyRevision: Stores topology revision as int.
text sessionState: Stores session state as text.
list of text events: Stores events as list of text.
nativeUiHostReferenceProvider(nativeUiHostCapabilityRecord capabilities, int ownerThread): Native ui host reference provider.
Reject(text operation, text reason) returns bool: Reject. Complete example
CapabilityAvailable(text capability) returns bool: Capability available. Complete example
Ready(int thread, text capability) returns bool: Ready. Complete example
Initialize(bool providerAvailable, bool failAfterCapabilities, int thread, int timestampMicroseconds, int correlationId) returns bool: Initialize. Complete example
Record(text category, text subject, text eventState, text detail, int timestampMicroseconds, int correlationId, int latencyMicroseconds): Record. Complete example
ObserveWindowEvent(text windowId, text eventState, int timestampMicroseconds, int correlationId, int thread) returns bool: Observe window event. Complete example
AccessibilityNodeIndex(text nodeId) returns int: Accessibility node index. Complete example
BeginAccessibilityBatch(int thread, int timestampMicroseconds, int correlationId) returns bool: Begin accessibility batch. Complete example
PublishAccessibilityNode(text nodeId, int generation, text role, text name, int thread) returns bool: Publish accessibility node. Complete example
EndAccessibilityBatch(int thread, int timestampMicroseconds, int correlationId) returns bool: End accessibility batch. Complete example
RouteAccessibilityAction(text nodeId, int generation, text action, bool simulateReentrancy, int thread, int timestampMicroseconds, int correlationId) returns bool: Route accessibility action. Complete example
BeginTextInput(text windowId, text value, int selectionStart, int selectionLength, int replacementStart, int replacementLength, int caretX, int caretY, int caretWidth, int caretHeight, int candidateX, int candidateY, text purpose, text hints, bool deadKey, bool requestVirtualKeyboard, int thread, int timestampMicroseconds, int correlationId) returns bool: Begin text input. Complete example
UpdateSurroundingText(text windowId, text value, int selectionStart, int selectionLength, int deleteStart, int deleteLength, int thread, int timestampMicroseconds, int correlationId) returns bool: Update surrounding text. Complete example
CommitText(text windowId, text value, int replacementStart, int replacementLength, int thread, int timestampMicroseconds, int correlationId) returns bool: Commit text. Complete example
CancelText(text windowId, text reason, int thread, int timestampMicroseconds, int correlationId) returns bool: Cancel text. Complete example
TransferTextFocus(text fromWindowId, text toWindowId, int thread, int timestampMicroseconds, int correlationId) returns bool: Transfer text focus. Complete example
SetVirtualKeyboard(bool requested, bool visible, text keyboardState, int thread, int timestampMicroseconds, int correlationId) returns bool: Set virtual keyboard. Complete example
ClipboardFormatKnown(text format) returns bool: Clipboard format known. Complete example
SetClipboard(text owner, text format, text value, bool delayed, bool permissionGranted, int thread, int timestampMicroseconds, int correlationId) returns bool: Set clipboard. Complete example
MaterializeClipboard(text owner, text value, bool permissionGranted, int thread, int timestampMicroseconds, int correlationId) returns bool: Materialize clipboard. Complete example
ReadClipboard(text format, bool permissionGranted, int thread, int timestampMicroseconds, int correlationId) returns text: Read clipboard. Complete example
DisplayIndex(text displayId) returns int: Display index. Complete example
PublishDisplay(nativeUiDisplayRecord display, int thread) returns bool: Publish display. Complete example
CommitTopology(int thread, int timestampMicroseconds, int correlationId) returns bool: Commit topology. Complete example
SetSessionSuspended(bool suspended, text reason, int thread, int timestampMicroseconds, int correlationId) returns bool: Set session suspended. Complete example
ProviderLost(text reason, int thread, int timestampMicroseconds, int correlationId) returns bool: Provider lost. Complete example
TearDown(int thread, int timestampMicroseconds, int correlationId) returns bool: Tear down. Complete example
EventAt(int index) returns text: Event at. Complete example
Describe() returns text: Describe. Complete example

Use nativeUiHostReferenceProvider

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using host.ui_services

// Define host text, editing, clipboard, and accessibility service contracts.
nativeUiHostReferenceProvider sample = nativeUiHostReferenceProvider(nativeUiHostCapabilityRecord("provider", true, true, true, true, true, true, true), 1)
Console.Log(Text.From(sample.schema))

project.mech

manifestVersion = "2"
package = "api.example.host_ui_services__nativeuihostreferenceprovider"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"