@edifice.io/client/dist/workspace/Service.d.ts

Edifice TypeScript Client

import { ID } from '../globals';
import { IOdeServices } from '../services/OdeServices';
import { WorkspaceElement, WorkspaceSearchFilter, WorkspaceVisibility } from './interface';
interface ElementQuery {
    /**
     * Keep only results having this criteria.
     * Defaults to "owner" in backend but must be specified here for clarity.
     */
    filter: WorkspaceSearchFilter;
    /** Restrict results to this element id only (kind of get). */
    id?: ID;
    /** Restrict results to element having this direct parent (folder). */
    parentId?: ID;
    /** Restrict results to elements having this ancestor (folder) at any level. */
    ancestorId?: string;
    /** Restrict results to the 1st folder hierarchy level. */
    onlyRoot?: boolean;
    /** Restrict results to this app. */
    application?: string;
    /** Restrict results to elements containing this text. */
    search?: string;
    /** Extend results to files AND folders. Defaults to false, with file results only. */
    includeall?: boolean;
    /** Max number of results needed. */
    limit?: number;
    /**
     * Skip the first N results.
     * Allows for pagination when used with the `limit` parameter.
     */
    skip?: number;
    /**
     * Restrict results to elements directly shared with the user.
     * => Handle this param through a dedicated method. Do not expose it directly.
     */
    directShared?: boolean;
    /**
     * Truthy when result is a tree ?
     * => Handle this param through a dedicated method. Do not expose it directly.
     */
    hierarchical?: boolean;
}
export declare class WorkspaceService {
    private context;
    constructor(context: IOdeServices);
    private get http();
    private extractMetadata;
    saveFile(file: Blob | File, params?: {
        parentId?: string;
        visibility?: WorkspaceVisibility;
        application?: string;
    }): Promise<WorkspaceElement>;
    updateFile(id: string, file: Blob | File, params?: {
        alt?: string;
        legend?: string;
        name?: string;
    }): Promise<any>;
    deleteFile(elements: WorkspaceElement[]): Promise<void>;
    private acceptDocuments;
    searchDocuments(params: ElementQuery): Promise<WorkspaceElement[]>;
    listDocuments(filter: WorkspaceSearchFilter, parentId?: ID): Promise<WorkspaceElement[]>;
    /**
     * Duplicate and transfers documents if needed to a different folder with the specified application and visibility.
     * @param documents - The array of documents to transfer.
     * @param application - The application to associate with the transferred documents.
     * @param visibility - The visibility of the transferred documents. Defaults to "protected".
     * @returns A Promise that resolves to an array of transferred WorkspaceElements.
     */
    transferDocuments(documents: WorkspaceElement[], application: string, visibility?: WorkspaceVisibility): Promise<WorkspaceElement[]>;
    /**
     * Get the URL of the thumbnail of a workspace element (or its URL),
     * or `null` if none exists or can be created.
     */
    getThumbnailUrl(doc: WorkspaceElement | string, width?: number, height?: number): string | null;
    /**
     * Get the URL of the file of a workspace element (or its URL),
     * or `null` if none exists or can be created.
     * @param filter - The filter to apply to the workspace element.
     * @param withChildren - If true, include all children folders.
     * @param parentId - The ID of the parent folder to list.
     * @param directShared - If true, include only elements directly shared with the user.
     *
     */
    listFolder(filter: WorkspaceSearchFilter, withChildren?: boolean, parentId?: ID, directShared?: boolean): Promise<WorkspaceElement[]>;
    /**
     * List all folders in the workspace.
     * @param withChildren - If true, include all children folders.
     * @param parentId - The ID of the parent folder to list.
     * @returns A promise that resolves to an array of WorkspaceElement objects.
     */
    listOwnerFolders(withChildren?: boolean, parentId?: ID): Promise<WorkspaceElement[]>;
    /**
     * List all shared folders in the workspace.
     * @param withChildren - If true, include all children folders.
     * @param parentId - The ID of the parent folder to list.
     * @returns A promise that resolves to an array of WorkspaceElement objects.
     */
    listSharedFolders(withChildren?: boolean, parentId?: ID): Promise<WorkspaceElement[]>;
    /**
     * Create a new folder in the workspace.
     * @param name - The name of the new folder.
     * @param parentId - The ID of the parent folder where the new folder will be created.
     * @returns void
     */
    createFolder(name: string, parentId?: string): Promise<any>;
}
export {};