App Links

The app links bridge turns links to the app — custom schemes, universal links and app links — into routes in the web app.

Install and register

dotnet add package Shiny.AppDeviceBridge.AppLinks

builder.UseAppDeviceBridge(
    bridge => bridge.AddAppLinksBridge(o => o.Schemes.Add("myapp")),
    webApp => { /* … */ }
);

Client	C#	TypeScript
ILinksBridge	AddWebAppHostClient() (built in)	LinksBridge

Details

Links to the app become routes in the web app. A custom scheme’s host is the first path segment, so myapp://orders/42 becomes /orders/42. An https link on a listed host keeps its path, so https://app.example.com/orders/42 also becomes /orders/42. Set MapRoute to map links another way.

Topic	Details
Other links	any other scheme or host is left to the native app.
Route checks	a route must be a local page path. Routes that aren’t, including anything under /_bridge or /_host, are refused, whatever MapRoute returns.
Delivery	the page gets app.link while it’s open. DELETE /_bridge/links/pending returns the latest link and removes it. Call it at boot and on each event, so a link is acted on exactly once.
Cold start	with NavigateOnColdStart, a link that launched the app becomes the first page loaded, and is consumed.
Background	links never go to background.js.

const links = new LinksBridge();

async function openPendingLink() {
    const link = await links.consume();
    if (link) router.push(link.route);
}

openPendingLink();
links.onLink(openPendingLink);

Platform setup:

Platform	Details
Android	a SingleTop main activity with ACTION_VIEW intent filters, plus assetlinks.json for https.
Apple	CFBundleURLTypes, plus the Associated Domains entitlement and apple-app-site-association for https.
maui-labs AppKit	the head overrides OpenUrls and calls AppLinks.Receive, because the launching link arrives before MauiProgram.
Windows	a protocol registration; redirect activations to the first instance for links while running.
Linux	x-scheme-handler in the .desktop file; cold starts only.

Requests

GET/_bridge/links/pendingThe latest link, left in place.DELETE/_bridge/links/pendingThe latest link, taken off the host so it is acted on once.

GET/_bridge/links/pending#

The latest link, left in place. Null when there is none.

C#ILinksBridge.GetPendingAsyncTSLinksBridge.getPending

Response

200 AppLink · or 204 when there is none

AppLink · 3 fields

url	string	The link as the OS delivered it.
route	string	The page route it maps to — always a local path, safe to navigate to as it is.
receivedAt	string	When the app received it.

DELETE/_bridge/links/pending#

The latest link, taken off the host so it is acted on once. Null when there is none.

C#ILinksBridge.ConsumeAsyncTSLinksBridge.consume

Response

200 AppLink · or 204 when there is none

AppLink · 3 fields

url	string	The link as the OS delivered it.
route	string	The page route it maps to — always a local path, safe to navigate to as it is.
receivedAt	string	When the app received it.

Events

EVENTapp.link#

A link arrived while the page is open. It is also left pending until consumed.

C#ILinksBridge.OnLinkAsyncTSLinksBridge.onLink

Payload

AppLink

url	string	The link as the OS delivered it.
route	string	The page route it maps to — always a local path, safe to navigate to as it is.
receivedAt	string	When the app received it.

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.

AppLinkobject#

A link the app was opened with.

url	string	The link as the OS delivered it.
route	string	The page route it maps to — always a local path, safe to navigate to as it is.
receivedAt	string	When the app received it.

Security

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