Type Alias AppSession

An object that represents one usage of an enigma websocket connected to the engine.

type AppSession = {
    close: (props?: CloseProps) => Promise<void>;
    getDoc: () => Promise<Doc>;
    onWebSocketEvent: (listener: (event: WebSocketEvent) => void) => () => void;
    resume: () => Promise<void>;
}
Index

Properties

close getDoc onWebSocketEvent resume

Properties

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.

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.

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

Add an event-listener for this app-session.

resume: () => Promise<void>

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

Settings

Member Visibility

On This Page

Properties