Interface NotificationChannel

Internal representation of a notification channel. Most of the fields are those defined in https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-data-model

We only support notification channels with a single topic.

Hierarchy

Properties

accept? endAt? id lastEmit? rate? receiveFrom? sendTo? sender? startAt? state? topic type

Properties

Optional accept

accept?: string

The media type in which the receiver expects the notifications.

Optional endAt

endAt?: number

When the channel should stop existing, in milliseconds since epoch.

id

id: string

The unique identifier of the channel.

Optional lastEmit

lastEmit?: number

Internal value that we use to track when this channel last sent a notification.

Optional rate

rate?: number

The minimal time required between notifications, in milliseconds.

Optional receiveFrom

receiveFrom?: string

The resource receivers can use to establish a connection and receive notifications.

Optional sendTo

sendTo?: string

The resource on the receiver where notifications can be sent.

Optional sender

sender?: string

Can be used to identify the sender.

Optional startAt

startAt?: number

When the channel should start sending notifications, in milliseconds since epoch.

Optional state

state?: string

The state parameter sent by the receiver. This is used to send a notification when the channel is established and the topic resource has a different state.

topic

topic: string

The resource this channel sends notifications about.

type

type: string

The channel type.

Settings

Member Visibility

Theme

On This Page