Class ClientEvent

Hierarchy

EventTarget
- ClientEvent

Constructors

constructor

new ClientEvent(): ClientEvent
Returns ClientEvent
Overrides EventTarget.constructor
- Defined in client/ClientEvent.ts:80

Properties

`Protected`abortController

abortController: AbortController

Methods

addConnectionCloseListener

addConnectionCloseListener(
    callback: (
        __namedParameters: { code: number; message?: string },
    ) => void,
): void
Parameters
- callback: (__namedParameters: { code: number; message?: string }) => void
Returns void
- Defined in client/ClientEvent.ts:173

addConnectionStatusChangedListener

addConnectionStatusChangedListener(
callback: (status: TConnectionStatus) => void,
): void
Parameters
- callback: (status: TConnectionStatus) => void
Returns void
- Defined in client/ClientEvent.ts:190

addContentChangedListener

addContentChangedListener(callback: (context: THistoryContext) => void): void
Parameters
- callback: (context: THistoryContext) => void
Returns void
- Defined in client/ClientEvent.ts:133

addEndInitialization

addEndInitialization(callback: () => void): void
Parameters
- callback: () => void
Returns void
- Defined in client/ClientEvent.ts:110

addErrorListener

addErrorListener(callback: (err: Error) => void): void
Parameters
- callback: (err: Error) => void
Returns void
- Defined in client/ClientEvent.ts:164

addExportedListener

addExportedListener(callback: (exports: TExport) => void): void
Parameters
- callback: (exports: TExport) => void
Returns void
- Defined in client/ClientEvent.ts:153

addGestureDetectedListener

addGestureDetectedListener(
callback: (gesture: TWebSocketClientMessageGesture) => void,
): void
Parameters
- callback: (gesture: TWebSocketClientMessageGesture) => void
Returns void
- Defined in client/ClientEvent.ts:201

addIdleListener

addIdleListener(callback: (idle: boolean) => void): void
Parameters
- callback: (idle: boolean) => void
Returns void
- Defined in client/ClientEvent.ts:144

addSessionOpenedListener

addSessionOpenedListener(callback: (sessionId: string) => void): void
Parameters
- callback: (sessionId: string) => void
Returns void
- Defined in client/ClientEvent.ts:119

addStartInitialization

addStartInitialization(callback: () => void): void
Parameters
- callback: () => void
Returns void
- Defined in client/ClientEvent.ts:101

addSVGPatchListener

addSVGPatchListener(
callback: (svgPatch: TWebSocketSSRClientMessageSVGPatch) => void,
): void
Parameters
- callback: (svgPatch: TWebSocketSSRClientMessageSVGPatch) => void
Returns void

Remarks
only usable in the case of websocket
- Defined in client/ClientEvent.ts:218

`Protected`emit

emit(type: string, data?: unknown): void
Parameters
- type: string
- Optionaldata: unknown
Returns void
- Defined in client/ClientEvent.ts:90

emitConnectionClose

emitConnectionClose(__namedParameters: { code: number; message?: string }): void
Parameters
- __namedParameters: { code: number; message?: string }
Returns void
- Defined in client/ClientEvent.ts:170

emitConnectionStatusChanged

emitConnectionStatusChanged(status: TConnectionStatus): void
Parameters
- status: TConnectionStatus
Returns void
- Defined in client/ClientEvent.ts:187

emitContentChanged

emitContentChanged(undoRedoContext: THistoryContext): void
Parameters
- undoRedoContext: THistoryContext
Returns void
- Defined in client/ClientEvent.ts:127

emitEndInitialization

emitEndInitialization(): void
Returns void
- Defined in client/ClientEvent.ts:107

emitError

emitError(err: Error): void
Parameters
- err: Error
Returns void
- Defined in client/ClientEvent.ts:161

emitExported

emitExported(exports: TExport): void
Parameters
- exports: TExport
Returns void
- Defined in client/ClientEvent.ts:150

emitGestureDetected

emitGestureDetected(gesture: TWebSocketClientMessageGesture): void
Parameters
- gesture: TWebSocketClientMessageGesture
Returns void
- Defined in client/ClientEvent.ts:198

emitIdle

emitIdle(idle: boolean): void
Parameters
- idle: boolean
Returns void
- Defined in client/ClientEvent.ts:141

emitSessionOpened

emitSessionOpened(sessionId: string): void
Parameters
- sessionId: string
Returns void
- Defined in client/ClientEvent.ts:116

emitStartInitialization

emitStartInitialization(): void
Returns void
- Defined in client/ClientEvent.ts:98

emitSVGPatch

emitSVGPatch(svgPatch: TWebSocketSSRClientMessageSVGPatch): void
Parameters
- svgPatch: TWebSocketSSRClientMessageSVGPatch
Returns void

Remarks
only use in the case of websocket
- Defined in client/ClientEvent.ts:212

removeAllListeners

removeAllListeners(): void
Returns void
- Defined in client/ClientEvent.ts:85