camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / Notification

Interface: Notification ​

Defined in: plugin/notifier.ts:45

Payload published via api.notificationManager.publish or routed by the host. Plugins fill the user-visible fields; the host stamps the message id, timestamp and source identifier on receive — plugins do not set those.

Properties ​

adminOnly? ​

optional adminOnly?: boolean

Defined in: plugin/notifier.ts:93

Restricts delivery to users with the master or admin role. Use it for operational alerts that concern whoever runs the instance — camera offline, disk full, plugin failures — so they don't reach guests the instance is merely shared with. Defaults to false (every user of the instance receives it, subject to their own notification settings).

body? ​

optional body?: string

Defined in: plugin/notifier.ts:55

Optional secondary text.

data? ​

optional data?: Record<string, string>

Defined in: plugin/notifier.ts:85

Plugin-specific context (cameraId, eventId, plugin-defined keys). String values keep the wire format predictable across notifier implementations.

optional deepLink?: string

Defined in: plugin/notifier.ts:80

Router-relative path consumed by mobile / web tap-handlers (e.g. '/cameras/cam-1?startTs=…'). No host, no scheme.

imageUrl? ​

optional imageUrl?: string

Defined in: plugin/notifier.ts:75

Publicly-fetchable URL to a rich image (e.g. a detection snapshot). Notifier-agnostic: FCM/APNs and other notifiers fetch it to render the image. Preferred over inline Notification.thumbnail bytes when a URL is available; empty renders text-only.

severity? ​

optional severity?: Severity

Defined in: plugin/notifier.ts:60

Drives DND / Critical-Alerts behaviour and Quiet-Hours bypass. Defaults to Severity.Info if omitted.

subtitle? ​

optional subtitle?: string

Defined in: plugin/notifier.ts:53

Optional second bold line between title and body. Honoured natively on iOS (APNs alert.subtitle); other notifiers may fold it into the body or ignore it.

tag? ​

optional tag?: string

Defined in: plugin/notifier.ts:66

Collapse-key for dedup at both manager and notifier level (e.g. 'motion:cam-1' — multiple events with the same tag inside the throttle window collapse into one notification on the device).

thumbnail? ​

optional thumbnail?: Uint8Array<ArrayBufferLike>

Defined in: plugin/notifier.ts:68

Optional inline JPEG attached to the notification.

title ​

title: string

Defined in: plugin/notifier.ts:47

Headline shown by every notifier.