@inrupt/solid-client-notifications / websocketNotification / IWebsocketNotification

Interface: IWebsocketNotification

websocketNotification.IWebsocketNotification

Implemented by

• WebsocketNotification

Table of contents

Methods

• off

• on

• once

Methods

off

▸ off(event, listener): this

Removes a listener for the “connected” event

Parameters

Name	Type
event	"connected"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:44

▸ off(event, listener): this

Removes a listener for the “closed” event

Parameters

Name	Type
event	"closed"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:57

▸ off(event, listener): this

Removes a listener for the “message” event

Parameters

Name	Type
event	"message"
listener	(notification: object) => void

Returns

this

Defined in

src/websocketNotification.ts:77

▸ off(event, listener): this

Removes a listener for the “error” event

Parameters

Name	Type
event	"error"
listener	(error: ErrorEvent) => void

Returns

this

Defined in

src/websocketNotification.ts:90

---

on

▸ on(event, listener): this

Emitted when the connection is established

Parameters

Name	Type
event	"connected"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:36

▸ on(event, listener): this

Emitted when the connection is closed

Parameters

Name	Type
event	"closed"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:49

▸ on(event, listener): this

Emitted when a valid notification is received, the payload is a activitystreams Activity.

Parameters

Name	Type
event	"message"
listener	(notification: object) => void

Returns

this

Defined in

src/websocketNotification.ts:65

▸ on(event, listener): this

Emitted when an error is encountered on the WebSocket

Parameters

Name	Type
event	"error"
listener	(error: ErrorEvent) => void

Returns

this

Defined in

src/websocketNotification.ts:82

---

once

▸ once(event, listener): this

Emitted when the next connection is established

Parameters

Name	Type
event	"connected"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:40

▸ once(event, listener): this

Emitted when the next connection is closed

Parameters

Name	Type
event	"closed"
listener	() => void

Returns

this

Defined in

src/websocketNotification.ts:53

▸ once(event, listener): this

Emitted when the next valid notification is received, the payload is a activitystreams Activity.

Parameters

Name	Type
event	"message"
listener	(notification: object) => void

Returns

this

Defined in

src/websocketNotification.ts:72

▸ once(event, listener): this

Emitted when the next error is encountered on the WebSocket

Parameters

Name	Type
event	"error"
listener	(error: ErrorEvent) => void

Returns

this

Defined in

src/websocketNotification.ts:86