iink-ts - v4.0.0
    Preparing search index...

    Class WebSocketClient

    Index
    constructor
    asVariableDefinitionDeferred availableActionsDeferred boundCloseCallback boundMessageCallback boundOpenCallback closeDeferred? configuration contextlessGestureDeferred currentErrorCode? currentPartId? evaluateDeferred event exportDeferredMap getDiagnosticDeferred getEvaluablesDeferred getVariableDefinitionsDeferred getVariablesDeferred getVariableValueDeferred initialized numericalComputationDeferred pingCount pingWorker? reconnectionCount removeVariableValueDeferred sendToSupportDeferred sessionId? setVariableValueDeferred socket url waitForIdleDeferred?
    isOffline mimeTypes offlineQueueLength
    addStrokes asVariableDefinition buildAddStrokesMessage buildEraseStrokesMessage buildReplaceStrokesMessage buildTransformMatrixMessage buildTransformRotateMessage buildTransformScaleMessage buildTransformTranslateMessage buildUndoRedoChanges clear clearSocketListener close closeCallback destroy eraseStrokes evaluate export getAvailableActions getDiagnostic getEvaluables getNumericalComputation getVariableDefinitions getVariables getVariableValue init initPing manageAck manageAuthenticated manageContentChangedMessage manageContextlessGesture manageErrorMessage manageExportMessage manageGestureDetected manageHMACChallenge manageMathSolverResult manageNewPartMessage managePartChangeMessage manageSessionDescriptionMessage manageWaitForIdle messageCallback newSession openCallback recognizeGesture redo rejectDeferredPending removeVariableValue replaceStrokes resetAllDeferred resolveAllInQueue resolveDeferredPending resolveFirstInQueue send sendToSupport setVariableValue transformMatrix transformRotate transformScale transformTranslate undo waitForIdle

    • Parameters

      • config: {
            recognition?: {
                alwaysConnected?: boolean;
                export?: {
                    image?: {
                        guides?: boolean;
                        viewport?: { height?: number; width?: number; x?: number; y?: number };
                    };
                    "image-resolution"?: number;
                    jiix?: {
                        "bounding-box"?: boolean;
                        "full-stroke-ids"?: boolean;
                        ids?: boolean;
                        strokes?: boolean;
                        style?: boolean;
                        text?: { chars?: boolean; lines?: boolean; words?: boolean };
                    };
                    mathml?: { flavor?: { name?: string } };
                };
                gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
                lang?: string;
                math?: {
                    solver?: {
                        "angle-unit"?: "deg" | "rad";
                        "auto-variable-management"?: {
                            enable?: boolean;
                            "scoping-policy"?: "closest" | "last-modified" | "last-edited";
                        };
                    };
                };
                "raw-content"?: {
                    classification?: { types?: ("text" | "shape" | "math" | undefined)[] };
                    gestures?: (
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                        | undefined
                    )[];
                    recognition?: { types?: ("text" | "shape" | "math" | undefined)[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (string | undefined)[];
                        customResources?: (string | undefined)[];
                    };
                };
            };
            server?: {
                applicationKey?: string;
                hmacKey?: string
                | {};
                host?: string;
                scheme?: TScheme;
                version?: string;
                websocket?: {
                    autoReconnect?: boolean;
                    fileChunkSize?: number;
                    maxPingLostCount?: number;
                    maxReconnectAttempts?: number;
                    maxRetryCount?: number;
                    offlineQueueEnabled?: boolean;
                    offlineQueueMaxSize?: number;
                    pingDelay?: number;
                    pingEnabled?: boolean;
                    reconnectDelay?: number;
                };
            };
        }
      • Optionalevent: ClientEvent

      Returns WebSocketClient

    asVariableDefinitionDeferred: Map<
        string,
        DeferredPromise<TMathVariableDefinition>[],
    >
    availableActionsDeferred: Map<string, DeferredPromise<string[]>[]>
    boundCloseCallback: (evt: CloseEvent) => void
    boundMessageCallback: (message: MessageEvent<string>) => void
    boundOpenCallback: () => void
    closeDeferred?: DeferredPromise<void>
    configuration: WebSocketClientConfiguration
    contextlessGestureDeferred: Map<
        string,
        DeferredPromise<TWebSocketClientMessageContextlessGesture>,
    >
    currentErrorCode?: string | number
    currentPartId?: string
    evaluateDeferred: Map<string, DeferredPromise<number[][]>[]>
    event: ClientEvent
    exportDeferredMap: Map<string, DeferredPromise<TExport>>
    getDiagnosticDeferred: Map<string, DeferredPromise<string>[]>
    getEvaluablesDeferred: Map<string, DeferredPromise<TMathEvaluable[]>[]>
    getVariableDefinitionsDeferred: DeferredPromise<TMathVariableDefinitions[]>[]
    getVariablesDeferred: Map<string, DeferredPromise<TMathVariable[]>[]>
    getVariableValueDeferred: Map<string, DeferredPromise<number>[]>
    initialized: DeferredPromise<void>
    numericalComputationDeferred: Map<string, DeferredPromise<string>[]>
    pingCount: number = 0
    pingWorker?: Worker
    reconnectionCount: number = 0
    removeVariableValueDeferred: Map<string, DeferredPromise<void>[]>
    sendToSupportDeferred: DeferredPromise<void>[]
    sessionId?: string
    setVariableValueDeferred: Map<string, DeferredPromise<void>[]>
    socket: WebSocket
    url: string
    waitForIdleDeferred?: DeferredPromise<void>
    • get isOffline(): boolean

      True while strokes are queued locally waiting for reconnection (see server.websocket.offlineQueueEnabled).

      Returns boolean

    • get mimeTypes(): string[]

      Returns string[]

    • get offlineQueueLength(): number

      Number of addStrokes batches currently queued locally while disconnected.

      Returns number

    • Parameters

      • strokes: TStroke[]
      • processGestures: boolean = true

      Returns Promise<void>

      Resolves once the message is sent, not once the server acks it — gesture detection results (if any) arrive asynchronously via event.addGestureDetectedListener, not this promise.

    • Parameters

      • strokeIds: string[]
      • angle: number
      • x0: number = 0
      • y0: number = 0

      Returns TWebSocketClientMessage

    • Parameters

      • strokeIds: string[]
      • scaleX: number
      • scaleY: number
      • x0: number = 0
      • y0: number = 0

      Returns TWebSocketClientMessage

    • Parameters

      • strokeIds: string[]
      • tx: number
      • ty: number

      Returns TWebSocketClientMessage

    • Returns Promise<void>

    • Returns void

    • Parameters

      • code: number
      • reason: string

      Returns Promise<void>

    • Parameters

      • evt: CloseEvent

      Returns void

    • Returns Promise<void>

    • Parameters

      • strokeIds: string[]

      Returns Promise<void>

    • Parameters

      • blockId: string
      • evaluation: {
            from: number;
            inputVariableName: string;
            outputVariableName: string;
            pointCount: number;
            to: number;
        }

      Returns Promise<{ [key: string]: number }[][]>

    • Parameters

      • OptionalrequestedMimeTypes: string[]

      Returns Promise<TExport>

    • Parameters

      • blockId: string

      Returns Promise<string[]>

    • Parameters

      • blockId: string
      • task: string

      Returns Promise<string>

    • Parameters

      • blockId: string

      Returns Promise<TMathEvaluable[]>

    • Parameters

      • blockId: string

      Returns Promise<TJIIXMathElement>

    • Parameters

      • blockId: string

      Returns Promise<TMathVariable[]>

    • Parameters

      • blockId: string
      • variableName: string

      Returns Promise<number>

    • Returns Promise<void>

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • message: MessageEvent<string>

      Returns void

    • Parameters

      • config: {
            recognition?: {
                alwaysConnected?: boolean;
                export?: {
                    image?: {
                        guides?: boolean;
                        viewport?: { height?: number; width?: number; x?: number; y?: number };
                    };
                    "image-resolution"?: number;
                    jiix?: {
                        "bounding-box"?: boolean;
                        "full-stroke-ids"?: boolean;
                        ids?: boolean;
                        strokes?: boolean;
                        style?: boolean;
                        text?: { chars?: boolean; lines?: boolean; words?: boolean };
                    };
                    mathml?: { flavor?: { name?: string } };
                };
                gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
                lang?: string;
                math?: {
                    solver?: {
                        "angle-unit"?: "deg" | "rad";
                        "auto-variable-management"?: {
                            enable?: boolean;
                            "scoping-policy"?: "closest" | "last-modified" | "last-edited";
                        };
                    };
                };
                "raw-content"?: {
                    classification?: { types?: ("text" | "shape" | "math" | undefined)[] };
                    gestures?: (
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                        | undefined
                    )[];
                    recognition?: { types?: ("text" | "shape" | "math" | undefined)[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (string | undefined)[];
                        customResources?: (string | undefined)[];
                    };
                };
            };
            server?: {
                applicationKey?: string;
                hmacKey?: string
                | {};
                host?: string;
                scheme?: TScheme;
                version?: string;
                websocket?: {
                    autoReconnect?: boolean;
                    fileChunkSize?: number;
                    maxPingLostCount?: number;
                    maxReconnectAttempts?: number;
                    maxRetryCount?: number;
                    offlineQueueEnabled?: boolean;
                    offlineQueueMaxSize?: number;
                    pingDelay?: number;
                    pingEnabled?: boolean;
                    reconnectDelay?: number;
                };
            };
        }

      Returns Promise<void>

    • Returns void

    • Parameters

      • error: string | Error

      Returns void

    • Parameters

      • blockId: string
      • variableName: string

      Returns Promise<void>

    • Parameters

      • oldStrokeIds: string[]
      • newStrokes: TStroke[]

      Returns Promise<void>

    • Returns void

    • Resolve every still-pending deferred in every queue of map with the same neutral value.

      Type Parameters

      • T

      Parameters

      Returns void

    • Settle completion-signal promises (no payload) as resolved rather than rejected — used on a deliberate close (close()/newSession()), which isn't an error: the operation the caller was waiting on (init, idle) is simply moot now, not failed.

      Returns void

    • Type Parameters

      • T

      Parameters

      Returns void

    • Parameters

      • data: Record<string, unknown>

      Returns Promise<void>

    • Parameters

      • blockId: string
      • variableName: string
      • variableValue: number

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • strokeIds: string[]
      • angle: number
      • x0: number = 0
      • y0: number = 0

      Returns Promise<void>

    • Parameters

      • strokeIds: string[]
      • scaleX: number
      • scaleY: number
      • x0: number = 0
      • y0: number = 0

      Returns Promise<void>

    • Parameters

      • strokeIds: string[]
      • tx: number
      • ty: number

      Returns Promise<void>

    • Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    addStrokesasVariableDefinitionbuildAddStrokesMessagebuildEraseStrokesMessagebuildReplaceStrokesMessagebuildTransformMatrixMessagebuildTransformRotateMessagebuildTransformScaleMessagebuildTransformTranslateMessagebuildUndoRedoChangesclearclearSocketListenerclosecloseCallbackdestroyeraseStrokesevaluateexportgetAvailableActionsgetDiagnosticgetEvaluablesgetNumericalComputationgetVariableDefinitionsgetVariablesgetVariableValueinitinitPingmanageAckmanageAuthenticatedmanageContentChangedMessagemanageContextlessGesturemanageErrorMessagemanageExportMessagemanageGestureDetectedmanageHMACChallengemanageMathSolverResultmanageNewPartMessagemanagePartChangeMessagemanageSessionDescriptionMessagemanageWaitForIdlemessageCallbacknewSessionopenCallbackrecognizeGestureredorejectDeferredPendingremoveVariableValuereplaceStrokesresetAllDeferredresolveAllInQueueresolveDeferredPendingresolveFirstInQueuesendsendToSupportsetVariableValuetransformMatrixtransformRotatetransformScaletransformTranslateundowaitForIdle