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

Notifications

The notifications bridge sends local notifications now, on a schedule, repeating or at a geofence, lists and cancels pending ones, sets the badge and manages channels. A tap reaches the page, or background.js when no page is open. It’s backed by Shiny.Notifications.

Android, iOS, Mac Catalyst, macOS, Windows, and Linux through Shiny.Notifications.Linux.

Install and register

dotnet add package Shiny.AppDeviceBridge.Notifications

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

Client	C#	TypeScript
`INotificationsBridge`	`AddNotificationsBridgeClient()`	`NotificationsBridge`

From the page

What send takes, and how taps reach background.js, is on Native Calls & Background.

import { NotificationsBridge } from "@shinyorg/appdevicebridge";

const notifications = new NotificationsBridge();
await notifications.requestAccess({ timeSensitive: false });

const { id } = await notifications.send({
    title: "Order ready",
    message: "Table 12 is up",
    scheduleDate: new Date(Date.now() + 60_000),
    data: { order: "1234" }
});

await notifications.onEntry(n => navigate(`/orders/${n.data.order}`));   // the user tapped it
await notifications.setBadge({ value: 3 });

Channels and actions

A channel can carry action buttons. requiresUnlock makes the user unlock the device before the action runs — use it for actions with a real-world effect, such as opening a garage door. It applies on iOS, Mac Catalyst and macOS, and on Android 12 and later; older Android versions run the action without asking, and Windows and Linux ignore it.

await notifications.addChannel({
    identifier: "garage",
    actions: [
        { identifier: "open", title: "Open Garage", actionType: "OpenApp", requiresUnlock: true },
        { identifier: "dismiss", title: "Dismiss", actionType: "Destructive", requiresUnlock: false }
    ]
});

The tapped action reaches notification.entry as action.

Requests

GET/_bridge/notifications#

Permission and what this platform supports.

C#INotificationsBridge.GetStatusAsyncTSNotificationsBridge.getStatus

Response

200 NotificationStatus

NotificationStatus · 6 fields

`access`	`AccessState`
`badge`	`boolean`	Whether the app badge can be read and set.
`entry`	`boolean`	Whether taps are reported.
`received`	`boolean`	Whether notifications arriving while the app is open are reported.
`geofences`	`boolean`	Whether a notification can wait for the device to enter an area.
`images`	`boolean`	Whether a notification can carry an image.

POST/_bridge/notifications/access#

Requests permission, optionally for time-sensitive and location-aware notifications too.

C#INotificationsBridge.RequestAccessAsyncTSNotificationsBridge.requestAccess

Body

application/json · NotificationAccessRequest

NotificationAccessRequest · 2 fields

`timeSensitive`	`boolean`
`locationAware`	`boolean`

Response

200 NotificationAccessResult

NotificationAccessResult · 1 field

access AccessState

POST/_bridge/notifications/send#

Sends or schedules a notification. Fails with 400 for an invalid one, such as a date already past.

C#INotificationsBridge.SendAsyncTSNotificationsBridge.send

Body

application/json · NotificationRequest

NotificationRequest · 12 fields

`message`	`string`	At most 4,000 characters.
`title`	`string \| null`
`subtitle`	`string \| null`
`id`	`number \| null`	Replaces a notification with the same id; assigned when null.
`channel`	`string \| null`	An Android channel identifier.
`thread`	`string \| null`	Groups notifications together.
`badgeCount`	`number \| null`
`scheduleDate`	`Date \| string \| null`	Show it then rather than now.
`repeat`	`NotificationRepeat \| null`
`geofence`	`NotificationGeofence \| null`
`image`	`BridgeFile \| null`	A .png, .jpg, .gif or .heic of at most 10 MB in a file root.
`data`	`Record<string, string> \| null`	Comes back on the tap.

Response

200 NotificationSent

NotificationSent · 1 field

id number

Errors

400Bad request

GET/_bridge/notifications/pending#

Scheduled notifications that have not been shown yet.

C#INotificationsBridge.GetPendingAsyncTSNotificationsBridge.getPending

Response

200 PendingNotification[]

PendingNotification · 11 fields

`id`	`number`
`title`	`string \| null`
`message`	`string \| null`
`channel`	`string \| null`
`thread`	`string \| null`
`badgeCount`	`number \| null`
`scheduleDate`	`string \| null`
`repeat`	`NotificationRepeat \| null`
`geofence`	`NotificationGeofence \| null`
`fromWebApp`	`boolean`	Whether the web app sent it, rather than the native app.
`data`	`Record<string, string>`

DELETE/_bridge/notifications#

Cancels pending notifications, clears displayed ones, or both.

C#INotificationsBridge.CancelAllAsyncTSNotificationsBridge.cancelAll

Parameter	In	Type
`scope`	query	`NotificationCancelScope`	optional

Response: 204 No content

DELETE/_bridge/notifications/{id}#

Cancels one notification.

C#INotificationsBridge.CancelAsyncTSNotificationsBridge.cancel

Parameter	In	Type
`id`	path	`number`	required

Response: 204 No content

GET/_bridge/notifications/badge#

The app icon's badge number.

C#INotificationsBridge.GetBadgeAsyncTSNotificationsBridge.getBadge

Response

200 NotificationBadge

NotificationBadge · 1 field

value number

PUT/_bridge/notifications/badge#

Sets the app icon's badge number, 0–99,999.

C#INotificationsBridge.SetBadgeAsyncTSNotificationsBridge.setBadge

Body

application/json · NotificationBadge

NotificationBadge · 1 field

value number

Response

204 No content

GET/_bridge/notifications/channels#

The notification channels.

C#INotificationsBridge.GetChannelsAsyncTSNotificationsBridge.getChannels

Response

200 NotificationChannel[]

NotificationChannel · 5 fields

`identifier`	`string`	1–64 letters, digits, `.`, `-` or `_`.
`description`	`string \| null`
`importance`	`ChannelImportance`
`sound`	`ChannelSound`
`actions`	`NotificationChannelAction[] \| null`

POST/_bridge/notifications/channels#

Adds or replaces a channel.

C#INotificationsBridge.AddChannelAsyncTSNotificationsBridge.addChannel

Body

application/json · NotificationChannel

NotificationChannel · 5 fields

`identifier`	`string`	1–64 letters, digits, `.`, `-` or `_`.
`description`	`string \| null`
`importance`	`ChannelImportance`
`sound`	`ChannelSound`
`actions`	`NotificationChannelAction[] \| null`

Response

200 NotificationChannel

NotificationChannel · 5 fields

`identifier`	`string`	1–64 letters, digits, `.`, `-` or `_`.
`description`	`string \| null`
`importance`	`ChannelImportance`
`sound`	`ChannelSound`
`actions`	`NotificationChannelAction[] \| null`

DELETE/_bridge/notifications/channels/{identifier}#

Removes a channel.

C#INotificationsBridge.RemoveChannelAsyncTSNotificationsBridge.removeChannel

Parameter	In	Type
`identifier`	path	`string`	required

Response: 204 No content

Events

EVENTnotification.entry#

The user tapped a notification, or one of its actions.

C#INotificationsBridge.OnEntryAsyncTSNotificationsBridge.onEntry

Payload: NotificationEvent

`id`	`number`
`title`	`string \| null`
`message`	`string \| null`
`channel`	`string \| null`
`thread`	`string \| null`
`data`	`Record<string, string>`
`action`	`string \| null`	The action chosen, when the user picked one rather than the notification itself.
`text`	`string \| null`	What the user typed, for a text reply action.

EVENTnotification.received#

A notification arrived while the app was open. Apple platforms only.

C#INotificationsBridge.OnReceivedAsyncTSNotificationsBridge.onReceived

Payload: NotificationEvent

`id`	`number`
`title`	`string \| null`
`message`	`string \| null`
`channel`	`string \| null`
`thread`	`string \| null`
`data`	`Record<string, string>`
`action`	`string \| null`	The action chosen, when the user picked one rather than the notification itself.
`text`	`string \| null`	What the user typed, for a text reply action.

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.

NotificationStatusobject#

`access`	`AccessState`
`badge`	`boolean`	Whether the app badge can be read and set.
`entry`	`boolean`	Whether taps are reported.
`received`	`boolean`	Whether notifications arriving while the app is open are reported.
`geofences`	`boolean`	Whether a notification can wait for the device to enter an area.
`images`	`boolean`	Whether a notification can carry an image.

AccessStateenum#

Where a permission stands. Reported by every bridge that needs one; the names match Shiny's own.

"Unknown""NotSupported""NotSetup""Disabled""Restricted""Denied""Available"

NotificationAccessRequestobject#

`timeSensitive?`	`boolean`
`locationAware?`	`boolean`

NotificationAccessResultobject#

access AccessState

NotificationRequestobject#

A notification to send.

`message`	`string`	At most 4,000 characters.
`title?`	`string \| null`
`subtitle?`	`string \| null`
`id?`	`number \| null`	Replaces a notification with the same id; assigned when null.
`channel?`	`string \| null`	An Android channel identifier.
`thread?`	`string \| null`	Groups notifications together.
`badgeCount?`	`number \| null`
`scheduleDate?`	`Date \| string \| null`	Show it then rather than now.
`repeat?`	`NotificationRepeat \| null`
`geofence?`	`NotificationGeofence \| null`
`image?`	`BridgeFile \| null`	A .png, .jpg, .gif or .heic of at most 10 MB in a file root.
`data?`	`Record<string, string> \| null`	Comes back on the tap.

NotificationRepeatobject#

A repeating schedule: every intervalSeconds, or at timeOfDay, optionally on one day.

`intervalSeconds`	`number \| null`
`timeOfDay`	`string \| null`
`dayOfWeek`	`("Sunday" \| "Monday" \| "Tuesday" \| "Wednesday" \| "Thursday" \| "Friday" \| "Saturday") \| null`

NotificationGeofenceobject#

Show the notification when the device enters an area.

`latitude`	`number`
`longitude`	`number`
`radiusMeters`	`number`
`repeat`	`boolean`

BridgeFileobject#

A file the page can reach through the files bridge: a named root and a path inside it. Bridges that take or return a file use this, so nothing reaches the page that /_bridge/files would not also serve.

`root`	`string`
`path`	`string`

NotificationSentobject#

id number

PendingNotificationobject#

`id`	`number`
`title`	`string \| null`
`message`	`string \| null`
`channel`	`string \| null`
`thread`	`string \| null`
`badgeCount`	`number \| null`
`scheduleDate`	`string \| null`
`repeat`	`NotificationRepeat \| null`
`geofence`	`NotificationGeofence \| null`
`fromWebApp`	`boolean`	Whether the web app sent it, rather than the native app.
`data`	`Record<string, string>`

NotificationCancelScopeenum#

"All""Pending""Displayed"

NotificationBadgeobject#

value number

NotificationChannelobject#

`identifier`	`string`	1–64 letters, digits, `.`, `-` or `_`.
`description`	`string \| null`
`importance`	`ChannelImportance`
`sound`	`ChannelSound`
`actions`	`NotificationChannelAction[] \| null`

ChannelImportanceenum#

"Low""Normal""High""Critical"

ChannelSoundenum#

"None""Default""High""Custom"

NotificationChannelActionobject#

`identifier`	`string`
`title`	`string`
`actionType`	`ChannelActionType`
`requiresUnlock`	`boolean`	The device must be unlocked before the action runs — for actions with a real-world effect, such as "Open Garage". Combines with any `ChannelActionType`. Apple: always. Android: 12 (API 31) and later; older versions run the action without asking. Ignored on Windows and Linux.

ChannelActionTypeenum#

"TextReply""Destructive""OpenApp""None"

NotificationEventobject#

A notification the user tapped or that arrived while the app was open.

`id`	`number`
`title`	`string \| null`
`message`	`string \| null`
`channel`	`string \| null`
`thread`	`string \| null`
`data`	`Record<string, string>`
`action`	`string \| null`	The action chosen, when the user picked one rather than the notification itself.
`text`	`string \| null`	What the user typed, for a text reply action.

Security

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