This is an Alpha release of the API.

@inrupt/solid-client-notifications / liveNotification / LiveNotification

Class: LiveNotification

liveNotification.LiveNotification

Hierarchy

Constructors

constructor

+ new LiveNotification(topic: string, protocolList: string[], options?: BaseNotificationOptions): LiveNotification

Parameters:

Name

Type

topic

string

protocolList

string[]

options?

BaseNotificationOptions

Returns: LiveNotification

Overrides: BaseNotification

Defined in: src/liveNotification.ts:31

Properties

emitter

emitter: EventEmitter

Defined in: src/liveNotification.ts:31


features

features: FeatureOptions

Inherited from: BaseNotification.features

Defined in: src/notification.ts:62


fetch

fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration:

▸ (input: RequestInfo, init?: RequestInit): Promise<Response>

Parameters:

Name

Type

input

RequestInfo

init?

RequestInit

Returns: Promise<Response>

Defined in: node_modules/typescript/lib/lib.dom.d.ts:20004

Inherited from: BaseNotification.fetch

Defined in: src/notification.ts:58


gateway

Optional gateway: string

Inherited from: BaseNotification.gateway

Defined in: src/notification.ts:56


host

host: string

Inherited from: BaseNotification.host

Defined in: src/notification.ts:54


protocol

Optional protocol: string

Defined in: src/liveNotification.ts:29


protocols

protocols: string[]

Inherited from: BaseNotification.protocols

Defined in: src/notification.ts:60


status

status: statuses= “closed”

Inherited from: BaseNotification.status

Defined in: src/notification.ts:64


topic

topic: string

Inherited from: BaseNotification.topic

Defined in: src/notification.ts:52

Methods

connect

connect(): void

Returns: void

Defined in: src/liveNotification.ts:43


disconnect

disconnect(): void

Returns: void

Defined in: src/liveNotification.ts:48


fetchNotificationConnectionInfo

fetchNotificationConnectionInfo(): Promise<NotificationConnectionInfo>

Returns: Promise<NotificationConnectionInfo>

Inherited from: BaseNotification

Defined in: src/notification.ts:179


fetchProtocolNegotiationInfo

fetchProtocolNegotiationInfo(): Promise<NegotiationInfo>

Returns: Promise<NegotiationInfo>

Inherited from: BaseNotification

Defined in: src/notification.ts:146


on

on(eventName: string, eventFn: (arg?: any) => void): void

Parameters:

Name

Type

eventName

string

eventFn

(arg?: any) => void

Returns: void

Defined in: src/liveNotification.ts:54


setSessionFetch

setSessionFetch(sessionFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>): void

Parameters:

Name

Type

sessionFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Returns: void

Inherited from: BaseNotification

Defined in: src/notification.ts:116


getDefaultSessionFetch

StaticgetDefaultSessionFetch(): Promise<undefined | (input: RequestInfo, init?: RequestInit) => Promise<Response>>

Returns: Promise<undefined | (input: RequestInfo, init?: RequestInit) => Promise<Response>>

Inherited from: BaseNotification

Defined in: src/notification.ts:80