Class WebSocketChannel2023Type

The notification channel type WebSocketChannel2023 as described in https://solid.github.io/notifications/websocket-channel-2023

Requires read permissions on a resource to be able to receive notifications.

Hierarchy (view full)

BaseChannelType
- WebSocketChannel2023Type

Index

Constructors

constructor

new WebSocketChannel2023Type(route, features?): WebSocketChannel2023Type
Parameters
- route: InteractionRoute<never>
- Optionalfeatures: string[]
Returns WebSocketChannel2023Type
Overrides BaseChannelType.constructor
- Defined in src/server/notifications/WebSocketChannel2023/WebSocketChannel2023Type.ts:37

Properties

`Protected` `Readonly`features

features: NamedNode<string>[]

`Protected` `Readonly`logger

logger: Logger = ...

`Protected` `Readonly`path

path: string

`Protected` `Readonly`shacl

shacl: unknown

`Protected` `Optional`shaclQuads

shaclQuads?: Store<Quad, Quad, Quad, Quad>

`Protected` `Readonly`type

type: NamedNode<string>

Methods

completeChannel

completeChannel(channel): Promise<void>
This function will be called after the serialized channel is sent back as a response, allowing for any final actions that need to happen.
Parameters
- channel: NotificationChannel
  The notification channel that is completed.
Returns Promise<void>
Inherited from BaseChannelType.completeChannel
- Defined in src/server/notifications/BaseChannelType.ts:295

extractModes

extractModes(channel): Promise<AccessMap>
Determines which modes are required to allow the given notification channel.
Parameters
- channel: NotificationChannel
  The notification channel to verify.
Returns Promise<AccessMap>
The required modes.
Inherited from BaseChannelType.extractModes
- Defined in src/server/notifications/BaseChannelType.ts:290

getDescription

getDescription(): SubscriptionService
Returns the SubscriptionService that describes how to subscribe to this channel type.

Returns SubscriptionService
Inherited from BaseChannelType.getDescription
- Defined in src/server/notifications/BaseChannelType.ts:125

`Protected`getShaclQuads

getShaclQuads(): Promise<Store<Quad, Quad, Quad, Quad>>
Returns an N3.js Store containing quads corresponding to the stored SHACL representation. Caches this result so the conversion from JSON-LD to quads only has to happen once.

Returns Promise<Store<Quad, Quad, Quad, Quad>>
Inherited from BaseChannelType.getShaclQuads
- Defined in src/server/notifications/BaseChannelType.ts:160

initChannel

initChannel(data, credentials): Promise<WebSocketChannel2023>
Initiates the channel by first calling validateSubscription followed by quadsToChannel. Subclasses can override either function safely to impact the result of the function.
Parameters
- data: Store<Quad, Quad, Quad, Quad>
- credentials: Credentials
Returns Promise<WebSocketChannel2023>
Overrides BaseChannelType.initChannel
- Defined in src/server/notifications/WebSocketChannel2023/WebSocketChannel2023Type.ts:41

`Protected`quadsToChannel

quadsToChannel(data, subject): Promise<NotificationChannel>
Converts a set of quads to a NotificationChannel. Assumes the data is valid, so this should be called after validateSubscription.

The generated identifier will be a URL made by combining the base URL of the channel type with a unique identifier.

The values of the default features will be added to the resulting channel, subclasses with additional features that need to be added are responsible for parsing those quads.
Parameters
- data: Store<Quad, Quad, Quad, Quad>
  Data to convert.
- subject: Term
  The identifier of the notification channel description in the dataset.
Returns Promise<NotificationChannel>
The generated NotificationChannel.
Inherited from BaseChannelType.quadsToChannel
- Defined in src/server/notifications/BaseChannelType.ts:226

toJsonLd

toJsonLd(channel): Promise<Record<string, unknown>>
Converts the given channel to a JSON-LD description. All fields found in the channel, except lastEmit, will be part of the result subject, so subclasses should remove any fields that should not be exposed.
Parameters
- channel: NotificationChannel
Returns Promise<Record<string, unknown>>
Inherited from BaseChannelType.toJsonLd
- Defined in src/server/notifications/BaseChannelType.ts:264

`Protected`validateSubscription

validateSubscription(data): Promise<Term>
Validates whether the given data conforms to the stored SHACL shape. Will throw an UnprocessableEntityHttpError if validation fails. Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.
Parameters
- data: Store<Quad, Quad, Quad, Quad>
  The data to validate.
Returns Promise<Term>
The focus node that corresponds to the subject of the found notification channel description.
Inherited from BaseChannelType.validateSubscription
- Defined in src/server/notifications/BaseChannelType.ts:187

Class WebSocketChannel2023Type

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketChannel2023Type

Properties

Protected Readonlyfeatures

Protected Readonlylogger

Protected Readonlypath

Protected Readonlyshacl

Protected OptionalshaclQuads

Protected Readonlytype

Methods

completeChannel

Parameters

Returns Promise<void>

extractModes

Parameters

Returns Promise<AccessMap>

getDescription

Returns SubscriptionService

ProtectedgetShaclQuads

Returns Promise<Store<Quad, Quad, Quad, Quad>>

initChannel

Parameters

Returns Promise<WebSocketChannel2023>

ProtectedquadsToChannel

Parameters

Returns Promise<NotificationChannel>

toJsonLd

Parameters

Returns Promise<Record<string, unknown>>

ProtectedvalidateSubscription

Parameters

Returns Promise<Term>

Settings

On This Page

`Protected` `Readonly`features

`Protected` `Readonly`logger

`Protected` `Readonly`path

`Protected` `Readonly`shacl

`Protected` `Optional`shaclQuads

`Protected` `Readonly`type

`Protected`getShaclQuads

`Protected`quadsToChannel

`Protected`validateSubscription