Interface QixAPI

interface QixAPI {
    openAppSession: (
        appSessionProps: OpenAppSessionProps,
    ) => {
        close(props?: CloseProps): Promise<void>;
        getDoc(): Promise<Doc>;
        onWebSocketEvent(listener: (event: WebSocketEvent) => void): () => void;
        resume(): Promise<void>;
    };
}
Index

Properties

openAppSession

Properties

openAppSession: (
    appSessionProps: OpenAppSessionProps,
) => {
    close(props?: CloseProps): Promise<void>;
    getDoc(): Promise<Doc>;
    onWebSocketEvent(listener: (event: WebSocketEvent) => void): () => void;
    resume(): Promise<void>;
}

Open a qix session in engine on the current domain for the supplied appId. If the same app is opened multiple times only a single enigma websocket session is opened and shared. When all open sessions are closed again the shared enigma websocket session is also closed.

Settings

Member Visibility

On This Page

Properties