@inrupt/solid-client-notifications / websocketNotification / IWebsocketNotification
Interface: IWebsocketNotification#
websocketNotification.IWebsocketNotification
Implemented by#
Table of contents#
Methods#
Methods#
off#
▸ off(event, listener): IWebsocketNotification
Removes a listener for the “connected” event
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:44
▸ off(event, listener): IWebsocketNotification
Removes a listener for the “closed” event
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:57
▸ off(event, listener): IWebsocketNotification
Removes a listener for the “message” event
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:77
▸ off(event, listener): IWebsocketNotification
Removes a listener for the “error” event
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:90
on#
▸ on(event, listener): IWebsocketNotification
Emitted when the connection is established
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:36
▸ on(event, listener): IWebsocketNotification
Emitted when the connection is closed
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:49
▸ on(event, listener): IWebsocketNotification
Emitted when a valid notification is received, the payload is a activitystreams Activity.
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:65
▸ on(event, listener): IWebsocketNotification
Emitted when an error is encountered on the WebSocket
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:82
once#
▸ once(event, listener): IWebsocketNotification
Emitted when the next connection is established
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:40
▸ once(event, listener): IWebsocketNotification
Emitted when the next connection is closed
Parameters#
Name |
Type |
|---|---|
|
|
|
() => |
Returns#
Defined in#
src/websocketNotification.ts:53
▸ once(event, listener): IWebsocketNotification
Emitted when the next valid notification is received, the payload is a activitystreams Activity.
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:72
▸ once(event, listener): IWebsocketNotification
Emitted when the next error is encountered on the WebSocket
Parameters#
Name |
Type |
|---|---|
|
|
|
( |
Returns#
Defined in#
src/websocketNotification.ts:86