Options
All
  • Public
  • Public/Protected
  • All
Menu

Module models/common/WebSocketEventContainer

Index

Type aliases

DefaultWebSocketEventContainer

DefaultWebSocketEventContainer: WebSocketEventContainer<unknown>

WebSocketEventContainer

WebSocketEventContainer<TData>: { code?: number; data?: TData; eventType?: WebSocketEventType; message?: string; recipientReference?: string; senderReference?: string; success?: boolean }

Type parameters

  • TData

Type declaration

  • Optional code?: number

    The optional error code. Will be set in case of any error.

  • Optional data?: TData

    The data attached to the event. Might be null or undefined.

  • Optional eventType?: WebSocketEventType

    Runtime only. The event type. Should not be send through the socket.

  • Optional message?: string

    The optional message, most probably an error message.

  • Optional recipientReference?: string

    The senderReference of the originating event this event (probably eventType answer) is replying to.

  • Optional senderReference?: string

    The optional senders reference. Should be included as recipientReference when answering to this event.

  • Optional success?: boolean

    A flag indicating successful execution of the operation that invoked the web socket event.

Generated using TypeDoc. API-Dokumentation v2.0.1816. Zur Startseite © Copyright 2023 TERMINGO GmbH. All rights reserved.