Shiny Client v6.3Easy Live Activities, Game Center, Geospatial Geofencing, App Store APIs, More Thermal Printer Support, & Call Directory

Tray Icon & Quick Entry

The desktop package has two bridges: tray and menu bar icons with menus, badges, notifications and animation, and a quick entry prompt that opens over other applications from a global hotkey. Both hand what the user does back to the web app.

Install and register

dotnet add package Shiny.AppDeviceBridge.Desktop

builder.UseAppDeviceBridge(
    bridge => bridge.AddTrayIconBridge().AddQuickEntryBridge(),
    webApp => { /* … */ }
);

Client	C#	TypeScript
`ITrayBridge`	`AddTrayBridgeClient()`	`TrayBridge`
`IQuickEntryBridge`	`AddQuickEntryBridgeClient()`	`QuickEntryBridge`

Tray icon

The system tray on Windows, the menu bar on macOS, the status notifier area on Linux — desktop only, 501 elsewhere.

Topic	Details
Naming an icon	use `PUT /_bridge/tray/main` rather than `POST /_bridge/tray`. The first call creates the icon and later ones adopt it, so a page reload or an applied update doesn’t stack up a second icon. A `PUT` changes only the properties it sends; `""` clears `tooltip`, `title` or `badge`.
Images	either `{ "root": "data", "path": "icons/tray.png" }` — the same file roots the files bridge takes, so the page can’t point the tray at anything it couldn’t already read — or `{ "data": "…" }` holding base64, with or without a `data:` URI prefix, which is how a page ships an icon it drew itself. Set `"templateImage": true` for a black-with-alpha image macOS and Linux tint for light and dark menu bars.
Menus	each entry is `Item`, `Check`, `Separator` or `Submenu`, and its `id` is what comes back on `tray.menu`; omit it and one is assigned. Ids must be unique across the whole menu.
Clicks reach the web app either way	`tray.click` and `tray.menu` go out as events and as calls the page handles when it is open and `background.js` handles when it is not — which is the case a tray menu exists for. `tray.click` isn’t raised on Linux, where the app indicator handles clicks itself and opens the menu on its own (so `menu/show` is a no-op there).
Lifetime	icons outlive the page and are removed when the app shuts down, or by `DELETE /_bridge/tray/{id}`. `MaxIcons` (4) caps how many exist at once.

await new TrayBridge().put("main", {
    tooltip: "Field App",
    templateImage: true,
    icon: { root: "data", path: "icons/tray.png" },
    menu: { items: [
        { id: "open", label: "Open" },
        { type: "Separator" },
        { id: "sync", type: "Check", label: "Sync", checked: true }
    ] }
});

Quick entry

Shiny’s quick entry prompt as a borderless, always-on-top window that opens over other applications, in the style of Spotlight or a desktop assistant. The page configures it, hears what’s submitted and writes the answer back. Desktop only: macOS (AppKit and Catalyst), Windows and Linux; 501 elsewhere.

bridge.AddQuickEntryBridge(
    o => o.HotKey = "Ctrl+Alt+Space",                         // toggles the window from anywhere
    quickEntry => quickEntry.ScreenGlow = ScreenGlowTrigger.WhileBusy
);

Topic	Details
Opening it	the global hotkey, `POST quickentry/show` or `toggle`, or a tray click that calls one. `PUT quickentry/options` changes the hotkey (`""` removes it), size, placement and dismissal while the app runs; `hotKeyRegistered: false` in the status means another application already owns the combination.
The prompt	`PUT quickentry/prompt` sets the placeholder, suggestions (each with an optional `value` that comes back when it’s chosen), `isBusy` with `busyText`, and `response`, the text shown under the entry. Only what you send changes; `""` clears the response and `[]` the suggestions. What you set survives a window that rebuilds its prompt.
Answering	`quickentry.submitted` goes out as an event and as a call the page handles when it’s open and `background.js` handles when it isn’t, which is the usual case for a window summoned over other applications. Set `isBusy`, do the work, then set `response`.
The glow	`glow/show`, `glow/hide` and `glow/pulse` drive the colour wash around the screen’s edge; the `glow` option lights it while the window is open or while the prompt is busy.
Custom content	if the app replaces the prompt through `QuickEntryOptions.ContentFactory`, the prompt routes answer `409` and the window routes still work.

const quickEntry = new QuickEntryBridge();

await quickEntry.setPrompt({ placeholder: "Ask Field App…", suggestions: [{ text: "Sync now", value: "sync" }] });
quickEntry.onSubmitted(async ({ text, suggestion }) => {
    await quickEntry.setPrompt({ isBusy: true, busyText: "Thinking…" });
    await quickEntry.setPrompt({ isBusy: false, response: await answer(text, suggestion?.value) });
});

Requests

Tray/_bridge/tray12 requests · 2 events

System tray and menu bar icons on Windows, macOS and Linux: create and update them, give them menus, show notifications, animate them, and hear clicks and menu choices. Android and iOS fail with 501. Ids are 1–64 letters, digits, ., _ or -.

GET/_bridge/tray#

Whether tray icons are supported here, the limit, and the icons this page created.

C#ITrayBridge.GetStatusAsyncTSTrayBridge.getStatus

Response

200 TrayStatus

TrayStatus · 3 fields

`supported`	`boolean`
`maxIcons`	`number`
`icons`	`TrayIconInfo[]`

POST/_bridge/tray#

Creates an icon, assigning an id when id is null. Fails with 429 past the limit.

C#ITrayBridge.CreateAsyncTSTrayBridge.create

Body

application/json · TrayIconInput

TrayIconInput · 8 fields

`id`	`string \| null`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean \| null`
`templateImage`	`boolean \| null`	On macOS, let the menu bar tint the icon; use black with alpha.
`badge`	`string \| null`	A short count or label drawn over the icon.
`icon`	`TrayImage \| null`
`menu`	`TrayMenuInput \| null`

Response

200 TrayIconInfo

TrayIconInfo · 9 fields

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

Errors

429Too many

DELETE/_bridge/tray#

Removes every icon.

C#ITrayBridge.RemoveAllAsyncTSTrayBridge.removeAll

Response: 204 No content

GET/_bridge/tray/{id}#

One icon. Fails with 404 when there is no such icon.

C#ITrayBridge.GetAsyncTSTrayBridge.get

Parameter	In	Type
`id`	path	`string`	required

Response

200 TrayIconInfo

TrayIconInfo · 9 fields

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

Errors

404Not found

PUT/_bridge/tray/{id}#

Creates the icon, or updates it: only properties that are set change, and an empty string clears tooltip, title or badge. PUT by a fixed id lets a reloaded page adopt its icon rather than add another.

C#ITrayBridge.PutAsyncTSTrayBridge.put

Parameter	In	Type
`id`	path	`string`	required

Body

application/json · TrayIconInput

TrayIconInput · 8 fields

`id`	`string \| null`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean \| null`
`templateImage`	`boolean \| null`	On macOS, let the menu bar tint the icon; use black with alpha.
`badge`	`string \| null`	A short count or label drawn over the icon.
`icon`	`TrayImage \| null`
`menu`	`TrayMenuInput \| null`

Response

200 TrayIconInfo

TrayIconInfo · 9 fields

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

DELETE/_bridge/tray/{id}#

Removes an icon.

C#ITrayBridge.RemoveAsyncTSTrayBridge.remove

Parameter	In	Type
`id`	path	`string`	required

Response: 204 No content

PUT/_bridge/tray/{id}/menu#

Replaces an icon's menu.

C#ITrayBridge.SetMenuAsyncTSTrayBridge.setMenu

Parameter	In	Type
`id`	path	`string`	required

Body

application/json · TrayMenuInput

TrayMenuInput · 1 field

items TrayMenuItemInput[] | null

Response

200 TrayIconInfo

TrayIconInfo · 9 fields

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

POST/_bridge/tray/{id}/notification#

Shows a notification from the icon.

C#ITrayBridge.NotifyAsyncTSTrayBridge.notify

Parameter	In	Type
`id`	path	`string`	required

Body

application/json · TrayNotification

TrayNotification · 2 fields

`title`	`string \| null`
`message`	`string \| null`

Response

204 No content

PUT/_bridge/tray/{id}/animation#

Cycles the icon through two or more frames.

C#ITrayBridge.StartAnimationAsyncTSTrayBridge.startAnimation

Parameter	In	Type
`id`	path	`string`	required

Body

application/json · TrayAnimation

TrayAnimation · 2 fields

`frames`	`TrayImage[] \| null`	2–24 images.
`intervalMs`	`number`	Time per frame; at least 50 ms.

Response

200 TrayIconInfo

TrayIconInfo · 9 fields

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

DELETE/_bridge/tray/{id}/animation#

Stops animating and restores the icon.

C#ITrayBridge.StopAnimationAsyncTSTrayBridge.stopAnimation

Parameter	In	Type
`id`	path	`string`	required

Response: 204 No content

QuickEntry/_bridge/quickentry11 requests · 6 events

Quick entry: a prompt window that opens over other applications — from a global hotkey, a tray click or the page — in the style of Spotlight or a desktop assistant. The page configures the prompt, hears what is submitted, and writes the response back, and it keeps working with the app's own window closed: submissions also go to background.js. Windows, macOS and Linux; Android and iOS fail with 501.

GET/_bridge/quickentry#

Whether quick entry works here, and what it is doing.

C#IQuickEntryBridge.GetStatusAsyncTSQuickEntryBridge.getStatus

Response

200 QuickEntryStatus

QuickEntryStatus · 8 fields

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

PUT/_bridge/quickentry/options#

Changes how the window opens. A hotkey another application owns is reported, not an error.

C#IQuickEntryBridge.ConfigureAsyncTSQuickEntryBridge.configure

Body

application/json · QuickEntryOptionsInput

QuickEntryOptionsInput · 14 fields

`presentation`	`QuickEntryPresentation \| null`
`hotKey`	`string \| null`	A global shortcut such as `Cmd+Opt+Space` or `Ctrl+Alt+Space`; an empty string removes it.
`width`	`number \| null`	Device-independent pixels, 200 to 4000.
`collapsedHeight`	`number \| null`	The height with nothing below the entry row.
`maxHeight`	`number \| null`	The window grows to fit suggestions and a response, up to this.
`placement`	`QuickEntryPlacement \| null`
`topMarginRatio`	`number \| null`	For `TopCenter`: the top edge as a fraction of the screen, 0 to 1.
`bottomMarginRatio`	`number \| null`	For `BottomCenter`: the gap below as a fraction of the screen, 0 to 1.
`x`	`number \| null`	For `Manual`: screen coordinates from the top left.
`y`	`number \| null`
`dismissOnFocusLost`	`boolean \| null`	Close when another application takes focus.
`dismissOnEscape`	`boolean \| null`
`activateOnShow`	`boolean \| null`	Take keyboard focus when opening. Off for a window that should not steal typing.
`glow`	`QuickEntryGlowTrigger \| null`	What lights the glow around the screen's edge.

Response

200 QuickEntryStatus

QuickEntryStatus · 8 fields

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

POST/_bridge/quickentry/show#

Opens the window.

C#IQuickEntryBridge.ShowAsyncTSQuickEntryBridge.show

Response

200 QuickEntryStatus

QuickEntryStatus · 8 fields

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

POST/_bridge/quickentry/hide#

Closes the window.

C#IQuickEntryBridge.HideAsyncTSQuickEntryBridge.hide

Response

200 QuickEntryStatus

QuickEntryStatus · 8 fields

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

POST/_bridge/quickentry/toggle#

Opens the window if it is closed, and closes it if it is open.

C#IQuickEntryBridge.ToggleAsyncTSQuickEntryBridge.toggle

Response

200 QuickEntryStatus

QuickEntryStatus · 8 fields

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

GET/_bridge/quickentry/prompt#

The prompt. Fails with 409 when the app replaced the prompt with content of its own.

C#IQuickEntryBridge.GetPromptAsyncTSQuickEntryBridge.getPrompt

Response

200 QuickEntryPrompt

QuickEntryPrompt · 9 fields

`text`	`string`	What is typed in the entry right now.
`placeholder`	`string`
`isBusy`	`boolean`	Shows `busyText` and an animated orb in place of the entry, while the page works.
`busyText`	`string`
`response`	`string \| null`	Text shown under the entry — the answer to what was submitted.
`suggestions`	`QuickEntrySuggestion[]`
`showMicrophone`	`boolean`	Shows a microphone button, which raises `quickentry.microphone`.
`showSubmitButton`	`boolean`
`clearOnSubmit`	`boolean`	Empty the entry once a prompt is submitted.

Errors

409Conflict

PUT/_bridge/quickentry/prompt#

Changes the prompt: its placeholder, suggestions, busy state and response.

C#IQuickEntryBridge.SetPromptAsyncTSQuickEntryBridge.setPrompt

Body

application/json · QuickEntryPromptInput

QuickEntryPromptInput · 9 fields

`text`	`string \| null`
`placeholder`	`string \| null`
`isBusy`	`boolean \| null`
`busyText`	`string \| null`
`response`	`string \| null`
`suggestions`	`QuickEntrySuggestion[] \| null`
`showMicrophone`	`boolean \| null`
`showSubmitButton`	`boolean \| null`
`clearOnSubmit`	`boolean \| null`

Response

200 QuickEntryPrompt

QuickEntryPrompt · 9 fields

`text`	`string`	What is typed in the entry right now.
`placeholder`	`string`
`isBusy`	`boolean`	Shows `busyText` and an animated orb in place of the entry, while the page works.
`busyText`	`string`
`response`	`string \| null`	Text shown under the entry — the answer to what was submitted.
`suggestions`	`QuickEntrySuggestion[]`
`showMicrophone`	`boolean`	Shows a microphone button, which raises `quickentry.microphone`.
`showSubmitButton`	`boolean`
`clearOnSubmit`	`boolean`	Empty the entry once a prompt is submitted.

POST/_bridge/quickentry/prompt/reset#

Clears the entry, the response and the busy state.

C#IQuickEntryBridge.ResetPromptAsyncTSQuickEntryBridge.resetPrompt

Response

200 QuickEntryPrompt

QuickEntryPrompt · 9 fields

`text`	`string`	What is typed in the entry right now.
`placeholder`	`string`
`isBusy`	`boolean`	Shows `busyText` and an animated orb in place of the entry, while the page works.
`busyText`	`string`
`response`	`string \| null`	Text shown under the entry — the answer to what was submitted.
`suggestions`	`QuickEntrySuggestion[]`
`showMicrophone`	`boolean`	Shows a microphone button, which raises `quickentry.microphone`.
`showSubmitButton`	`boolean`
`clearOnSubmit`	`boolean`	Empty the entry once a prompt is submitted.

POST/_bridge/quickentry/glow/show#

Lights the glow around the screen's edge until hideGlow.

C#IQuickEntryBridge.ShowGlowAsyncTSQuickEntryBridge.showGlow

Response: 204 No content

POST/_bridge/quickentry/glow/hide#

C#IQuickEntryBridge.HideGlowAsyncTSQuickEntryBridge.hideGlow

Response: 204 No content

POST/_bridge/quickentry/glow/pulse#

Lights the glow for a while, answering once it has gone out.

C#IQuickEntryBridge.PulseGlowAsyncTSQuickEntryBridge.pulseGlow

Body

application/json · QuickEntryPulse

QuickEntryPulse · 1 field

durationMs number How long the glow stays lit: 100 ms to 30 s.

Response

204 No content

Events

Tray2 events

EVENTtray.click#

An icon was clicked. Also delivered to background.js when no page is listening.

C#ITrayBridge.OnClickAsyncTSTrayBridge.onClick

Payload: TrayClick

`id`	`string`	The icon clicked.
`button`	`TrayClickButton`
`x`	`number`	Screen coordinates, where the platform reports them.
`y`	`number`

QuickEntry6 events

EVENTquickentry.submitted#

The user submitted a prompt. Also delivered to background.js when no page is listening.

C#IQuickEntryBridge.OnSubmittedAsyncTSQuickEntryBridge.onSubmitted

Payload: QuickEntrySubmission

`text`	`string`
`suggestion`	`QuickEntrySuggestion \| null`	The suggestion chosen to submit it; null when it was typed.

EVENTquickentry.suggestion#

The user chose a suggestion, just before it is submitted.

C#IQuickEntryBridge.OnSuggestionAsyncTSQuickEntryBridge.onSuggestion

Payload: QuickEntrySubmission

`text`	`string`
`suggestion`	`QuickEntrySuggestion \| null`	The suggestion chosen to submit it; null when it was typed.

EVENTquickentry.cancelled#

The user pressed Escape in the prompt.

C#IQuickEntryBridge.OnCancelledAsyncTSQuickEntryBridge.onCancelled

Payload: QuickEntryPromptEvent

text string

EVENTquickentry.microphone#

The user pressed the microphone button.

C#IQuickEntryBridge.OnMicrophoneAsyncTSQuickEntryBridge.onMicrophone

Payload: QuickEntryPromptEvent

text string

EVENTquickentry.opened#

The window opened, however it was opened.

C#IQuickEntryBridge.OnOpenedAsyncTSQuickEntryBridge.onOpened

Payload: QuickEntryStatus

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

EVENTquickentry.closed#

The window closed, however it was dismissed.

C#IQuickEntryBridge.OnClosedAsyncTSQuickEntryBridge.onClosed

Payload: QuickEntryStatus

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

Types

JSON property names are camelCase and enums travel as their names. A ? marks a property the payload may omit;| null one that may be null.

TrayStatusobject#

`supported`	`boolean`
`maxIcons`	`number`
`icons`	`TrayIconInfo[]`

TrayIconInfoobject#

`id`	`string`
`tooltip`	`string \| null`
`title`	`string \| null`
`visible`	`boolean`
`templateImage`	`boolean`
`badge`	`string \| null`
`hasIcon`	`boolean`
`animating`	`boolean`
`menu`	`TrayMenuItemInfo[]`

TrayMenuItemInfoobject#

`id`	`string`
`type`	`TrayMenuItemType`
`label`	`string \| null`
`enabled`	`boolean`
`visible`	`boolean`
`checked`	`boolean \| null`	Null for anything but a check item.
`items`	`TrayMenuItemInfo[] \| null`

TrayMenuItemTypeenum#

"Item""Check""Separator""Submenu"

TrayIconInputobject#

An icon to create, or the changes to one. Properties left null are left as they are.

`id?`	`string \| null`
`tooltip?`	`string \| null`
`title?`	`string \| null`
`visible?`	`boolean \| null`
`templateImage?`	`boolean \| null`	On macOS, let the menu bar tint the icon; use black with alpha.
`badge?`	`string \| null`	A short count or label drawn over the icon.
`icon?`	`TrayImage \| null`
`menu?`	`TrayMenuInput \| null`

TrayImageobject#

An image: a file the page could already read through the files bridge (root and path), or base64 bytes it built itself (data, with or without a data: URI prefix).

`root?`	`string \| null`
`path?`	`string \| null`
`data?`	`string \| null`

TrayMenuInputobject#

A menu: at most 64 entries in all, nested at most 4 deep.

items? TrayMenuItemInput[] | null

TrayMenuItemInputobject#

One menu entry.

`id?`	`string \| null`	What comes back on `tray.menu`; assigned when null.
`type?`	`TrayMenuItemType`
`label?`	`string \| null`
`accelerator?`	`string \| null`	A shortcut such as `Ctrl+S`.
`enabled?`	`boolean`
`visible?`	`boolean`
`checked?`	`boolean`
`icon?`	`TrayImage \| null`
`items?`	`TrayMenuItemInput[] \| null`	A submenu's entries.

TrayNotificationobject#

`title?`	`string \| null`
`message?`	`string \| null`

TrayAnimationobject#

`frames?`	`TrayImage[] \| null`	2–24 images.
`intervalMs?`	`number`	Time per frame; at least 50 ms.

TrayClickobject#

`id`	`string`	The icon clicked.
`button`	`TrayClickButton`
`x`	`number`	Screen coordinates, where the platform reports them.
`y`	`number`

TrayClickButtonenum#

"Primary""Secondary""Double"

TrayMenuSelectionobject#

`id`	`string`	The icon whose menu it was.
`itemId`	`string`
`label`	`string \| null`
`checked`	`boolean \| null`	The new state of a check item; null for anything else.

QuickEntryStatusobject#

What quick entry can do here and what it is doing.

`supported`	`boolean`	False on Android and iOS, where every other call fails with 501.
`presentation`	`QuickEntryPresentation`	How the window will actually open, with `Auto` resolved.
`isOpen`	`boolean`
`glowSupported`	`boolean`
`glowVisible`	`boolean`
`hotKey`	`string \| null`	The global shortcut that toggles the window, when one is set.
`hotKeyRegistered`	`boolean`	False when the shortcut is set but another application already owns it.
`hasPrompt`	`boolean`	False when the app replaced the prompt with content of its own, which the prompt calls cannot drive.

QuickEntryPresentationenum#

"Auto""InApp""Desktop"

QuickEntryOptionsInputobject#

Changes to how the window opens. Properties left null are left as they are.

`presentation?`	`QuickEntryPresentation \| null`
`hotKey?`	`string \| null`	A global shortcut such as `Cmd+Opt+Space` or `Ctrl+Alt+Space`; an empty string removes it.
`width?`	`number \| null`	Device-independent pixels, 200 to 4000.
`collapsedHeight?`	`number \| null`	The height with nothing below the entry row.
`maxHeight?`	`number \| null`	The window grows to fit suggestions and a response, up to this.
`placement?`	`QuickEntryPlacement \| null`
`topMarginRatio?`	`number \| null`	For `TopCenter`: the top edge as a fraction of the screen, 0 to 1.
`bottomMarginRatio?`	`number \| null`	For `BottomCenter`: the gap below as a fraction of the screen, 0 to 1.
`x?`	`number \| null`	For `Manual`: screen coordinates from the top left.
`y?`	`number \| null`
`dismissOnFocusLost?`	`boolean \| null`	Close when another application takes focus.
`dismissOnEscape?`	`boolean \| null`
`activateOnShow?`	`boolean \| null`	Take keyboard focus when opening. Off for a window that should not steal typing.
`glow?`	`QuickEntryGlowTrigger \| null`	What lights the glow around the screen's edge.

QuickEntryPlacementenum#

"TopCenter""BottomCenter""Center""NearCursor""Manual"

QuickEntryGlowTriggerenum#

"None""WhileOpen""WhileBusy"

QuickEntryPromptobject#

The prompt in the window.

`text`	`string`	What is typed in the entry right now.
`placeholder`	`string`
`isBusy`	`boolean`	Shows `busyText` and an animated orb in place of the entry, while the page works.
`busyText`	`string`
`response`	`string \| null`	Text shown under the entry — the answer to what was submitted.
`suggestions`	`QuickEntrySuggestion[]`
`showMicrophone`	`boolean`	Shows a microphone button, which raises `quickentry.microphone`.
`showSubmitButton`	`boolean`
`clearOnSubmit`	`boolean`	Empty the entry once a prompt is submitted.

QuickEntrySuggestionobject#

A row under the entry.

`text`	`string`	What is written into the entry when it is chosen.
`description`	`string \| null`	A second line.
`glyph`	`string \| null`	A leading emoji or icon-font character.
`value`	`string \| null`	Anything the page wants back when the suggestion is chosen.

QuickEntryPromptInputobject#

Changes to the prompt. Properties left null are left as they are; an empty response removes the response and an empty suggestions list removes the suggestions. Everything but text is kept across a window that rebuilds its content on every open.

`text?`	`string \| null`
`placeholder?`	`string \| null`
`isBusy?`	`boolean \| null`
`busyText?`	`string \| null`
`response?`	`string \| null`
`suggestions?`	`QuickEntrySuggestion[] \| null`
`showMicrophone?`	`boolean \| null`
`showSubmitButton?`	`boolean \| null`
`clearOnSubmit?`	`boolean \| null`

QuickEntryPulseobject#

durationMs number How long the glow stays lit: 100 ms to 30 s.

QuickEntrySubmissionobject#

A prompt the user submitted.

`text`	`string`
`suggestion`	`QuickEntrySuggestion \| null`	The suggestion chosen to submit it; null when it was typed.

QuickEntryPromptEventobject#

The entry's text when the user cancelled or pressed the microphone.

text string

Security

These routes sit under AppDeviceBridgePolicies.Bridges like every other bridge: callers on this device by default. See Security.