@inrupt/solid-client-notifications
    Preparing search index...

    Interface IWebsocketNotification

    interface IWebsocketNotification {
        off(event: "connected", listener: () => void): this;
        off(event: "closed", listener: () => void): this;
        off(event: "message", listener: (notification: object) => void): this;
        off(event: "error", listener: (error: ErrorEvent) => void): this;
        on(event: "connected", listener: () => void): this;
        on(event: "closed", listener: () => void): this;
        on(event: "message", listener: (notification: object) => void): this;
        on(event: "error", listener: (error: ErrorEvent) => void): this;
        once(event: "connected", listener: () => void): this;
        once(event: "closed", listener: () => void): this;
        once(event: "message", listener: (notification: object) => void): this;
        once(event: "error", listener: (error: ErrorEvent) => void): this;
    }

    Implemented by

    Index

    Methods

    off on once

    Methods

    • Removes a listener for the "connected" event

      Parameters

      • event: "connected"
      • listener: () => void

      Returns this

    • Removes a listener for the "closed" event

      Parameters

      • event: "closed"
      • listener: () => void

      Returns this

    • Removes a listener for the "message" event

      Parameters

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

      Returns this

    • Removes a listener for the "error" event

      Parameters

      • event: "error"
      • listener: (error: ErrorEvent) => void

      Returns this

    • Emitted when the connection is established

      Parameters

      • event: "connected"
      • listener: () => void

      Returns this

    • Emitted when the connection is closed

      Parameters

      • event: "closed"
      • listener: () => void

      Returns this

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

      Parameters

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

      Returns this

    • Emitted when an error is encountered on the WebSocket

      Parameters

      • event: "error"
      • listener: (error: ErrorEvent) => void

      Returns this

    • Emitted when the next connection is established

      Parameters

      • event: "connected"
      • listener: () => void

      Returns this

    • Emitted when the next connection is closed

      Parameters

      • event: "closed"
      • listener: () => void

      Returns this

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

      Parameters

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

      Returns this

    • Emitted when the next error is encountered on the WebSocket

      Parameters

      • event: "error"
      • listener: (error: ErrorEvent) => void

      Returns this

    Settings

    Member Visibility

    On This Page

    Methods