Datalayer Desktop - v0.0.2
    Preparing search index...

    Interface DatalayerIPCClient

    Datalayer IPC Bridge API interface. Provides methods for interacting with the Datalayer SDK via IPC.

    interface DatalayerIPCClient {
        createLexical: (
            spaceId: string,
            name: string,
            description: string,
        ) => Promise<LexicalJSON>;
        createNotebook: (
            spaceId: string,
            name: string,
            description?: string,
        ) => Promise<NotebookJSON>;
        createRuntime: (
            options: {
                environmentName: string;
                givenName: string;
                minutesLimit: number;
                type: "notebook" | "terminal" | "job";
            },
        ) => Promise<RuntimeJSON>;
        deleteRuntime: (podName: string) => Promise<void>;
        deleteSpaceItem: (spaceId: string, itemId: string) => Promise<void>;
        getAuthState: () => Promise<
            {
                isAuthenticated: boolean;
                runUrl: string;
                token: null
                | string;
                user: null | UserJSON;
            },
        >;
        getCollaborationSession: (documentId: string) => Promise<string>;
        getCollaborationToken: () => Promise<
            { isAuthenticated: boolean; runUrl: string; token?: string },
        >;
        getContent: (itemId: string) => Promise<unknown>;
        getCredentials: () => Promise<
            { isAuthenticated: boolean; runUrl: string; token?: string },
        >;
        getMySpaces: () => Promise<SpaceJSON[]>;
        getRuntime: (runtimeId: string) => Promise<RuntimeJSON>;
        getSpaceItems: (spaceId: string) => Promise<(NotebookJSON | LexicalJSON)[]>;
        isRuntimeActive: (
            podName: string,
        ) => Promise<{ isActive: boolean; runtime?: RuntimeJSON }>;
        listEnvironments: () => Promise<EnvironmentJSON[]>;
        listNotebooks: () => Promise<NotebookJSON[]>;
        listRuntimes: () => Promise<RuntimeJSON[]>;
        login: (token: string) => Promise<void>;
        logout: () => Promise<void>;
        terminateAllRuntimes: () => Promise<PromiseSettledResult<void>[]>;
        updateLexical: (
            uid: string,
            name: string,
            description?: string,
        ) => Promise<LexicalJSON>;
        updateNotebook: (
            uid: string,
            name: string,
            description?: string,
        ) => Promise<NotebookJSON>;
        whoami: () => Promise<UserJSON>;
    }
    Index

    Properties

    createLexical: (
        spaceId: string,
        name: string,
        description: string,
    ) => Promise<LexicalJSON>
    createNotebook: (
        spaceId: string,
        name: string,
        description?: string,
    ) => Promise<NotebookJSON>
    createRuntime: (
        options: {
            environmentName: string;
            givenName: string;
            minutesLimit: number;
            type: "notebook" | "terminal" | "job";
        },
    ) => Promise<RuntimeJSON>
    deleteRuntime: (podName: string) => Promise<void>
    deleteSpaceItem: (spaceId: string, itemId: string) => Promise<void>
    getAuthState: () => Promise<
        {
            isAuthenticated: boolean;
            runUrl: string;
            token: null
            | string;
            user: null | UserJSON;
        },
    >
    getCollaborationSession: (documentId: string) => Promise<string>
    getCollaborationToken: () => Promise<
        { isAuthenticated: boolean; runUrl: string; token?: string },
    >
    getContent: (itemId: string) => Promise<unknown>
    getCredentials: () => Promise<
        { isAuthenticated: boolean; runUrl: string; token?: string },
    >
    getMySpaces: () => Promise<SpaceJSON[]>
    getRuntime: (runtimeId: string) => Promise<RuntimeJSON>
    getSpaceItems: (spaceId: string) => Promise<(NotebookJSON | LexicalJSON)[]>
    isRuntimeActive: (
        podName: string,
    ) => Promise<{ isActive: boolean; runtime?: RuntimeJSON }>
    listEnvironments: () => Promise<EnvironmentJSON[]>
    listNotebooks: () => Promise<NotebookJSON[]>
    listRuntimes: () => Promise<RuntimeJSON[]>
    login: (token: string) => Promise<void>
    logout: () => Promise<void>
    terminateAllRuntimes: () => Promise<PromiseSettledResult<void>[]>
    updateLexical: (
        uid: string,
        name: string,
        description?: string,
    ) => Promise<LexicalJSON>
    updateNotebook: (
        uid: string,
        name: string,
        description?: string,
    ) => Promise<NotebookJSON>
    whoami: () => Promise<UserJSON>