Interface NotificationChannelType

A specific channel type as defined at https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-types.

All functions that take a NotificationChannel as input only need to support channels generated by an initChannel on the same class.

Hierarchy

NotificationChannelType

Implemented by

BaseChannelType

Index

Properties

completeChannel extractModes getDescription initChannel toJsonLd

Properties

completeChannel

completeChannel: ((channel) => Promise<void>)

Type declaration

- (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>

extractModes

extractModes: ((channel) => Promise<AccessMap>)

Type declaration

- (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.

getDescription

getDescription: (() => SubscriptionService)

Type declaration

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

initChannel

initChannel: ((data, credentials) => Promise<NotificationChannel>)

Type declaration

- (data, credentials): Promise<NotificationChannel>
- Validate and convert the input quads into a NotificationChannel.
  Parameters
  - data: Store<Quad, Quad, Quad, Quad>
    
    The input quads.
  - credentials: Credentials
    
    The credentials of the agent doing the request.
  Returns Promise<NotificationChannel>

toJsonLd

toJsonLd: ((channel) => Promise<Record<string, unknown>>)

Type declaration

- (channel): Promise<Record<string, unknown>>
- Converts a NotificationChannel to a serialized JSON-LD representation.
  Parameters
  - channel: NotificationChannel
    
    The notification channel to serialize.
  Returns Promise<Record<string, unknown>>