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.

interface NotificationChannel {
    accept?: string;
    endAt?: number;
    id: string;
    lastEmit?: number;
    rate?: number;
    receiveFrom?: string;
    sendTo?: string;
    sender?: string;
    startAt?: number;
    state?: string;
    topic: string;
    type: string;
}

Hierarchy (view full)

Properties

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

Properties

Optionalaccept

accept?: string

The media type in which the receiver expects the notifications.

OptionalendAt

endAt?: number

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

id

id: string

The unique identifier of the channel.

OptionallastEmit

lastEmit?: number

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

Optionalrate

rate?: number

The minimal time required between notifications, in milliseconds.

OptionalreceiveFrom

receiveFrom?: string

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

OptionalsendTo

sendTo?: string

The resource on the receiver where notifications can be sent.

Optionalsender

sender?: string

Can be used to identify the sender.

OptionalstartAt

startAt?: number

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

Optionalstate

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

On This Page

Properties