Function openAppSession

Returns {
    close(props?: CloseProps): Promise<void>;
    getDoc(): Promise<Doc>;
    onOpenProgress(listener: (event: QixProgressEvent) => void): () => void;
    onReloadProgress(listener: (event: QixProgressEvent) => void): () => void;
    onSaveProgress(listener: (event: QixProgressEvent) => void): () => void;
    onWebSocketEvent(listener: (event: WebSocketEvent) => void): () => void;
    resume(): Promise<void>;
}

• close: function

  • close(props?: CloseProps): Promise<void>

    When the app session is no longer in use it must be closed using this function. If the same underlying enigma websocket is used somewhere else in the browser this is basically a no op, but if this is the last/only usage of the underlying enigma websocket that websocket will be closed.

    Parameters

    • Optionalprops: CloseProps

    Returns Promise<void>

• getDoc: function

  • getDoc(): Promise<Doc>

    Returns a promise of the Qix Doc object with a set of client-side Api extensions. Note that while the AppSession object is returned immediately this promise might take a while to resolve for bigger apps.

    Returns Promise<Doc>

• onOpenProgress: function

  • onOpenProgress(listener: (event: QixProgressEvent) => void): () => void
    Experimental

    Add a progress-listener for an app open process. This is the process behind the getDoc promise.

    Parameters

    • listener: (event: QixProgressEvent) => void

    Returns () => void

• onReloadProgress: function

  • onReloadProgress(listener: (event: QixProgressEvent) => void): () => void
    Experimental

    Add a progress-listener for an app reload process. A reload is triggered by calling Doc.DoReload or Doc.DoReloadEx.

    Parameters

    • listener: (event: QixProgressEvent) => void

    Returns () => void

• onSaveProgress: function

  • onSaveProgress(listener: (event: QixProgressEvent) => void): () => void
    Experimental

    Add a progress-listener for an app save process (triggered by DoSave on a Doc).

    Parameters

    • listener: (event: QixProgressEvent) => void

    Returns () => void

• onWebSocketEvent: function

  • onWebSocketEvent(listener: (event: WebSocketEvent) => void): () => void
    Experimental

    Add an event-listener for this app-session.

    Parameters

    • listener: (event: WebSocketEvent) => void

    Returns () => void

• resume: function

  • resume(): Promise<void>
    Experimental

    Resume a suspended session. This will resume exactly once if the session is currently suspended, otherwise nothing will be done.

    Returns Promise<void>