Interface IProjectApi

API for working with project, modules, and folders

interface IProjectApi {
    _apiId: "mendix.ProjectApi";
    addEventListener<K>(eventType: K, listener: EventHandler<{}, K>): DisposeListener;
    addFolder(containerId: string, name: string): Promise<Readonly<Folder>>;
    deleteFolder(folderId: string): Promise<void>;
    getDocumentsInfo(containerId: string): Promise<readonly Readonly<UnitInfo>[]>;
    getFolder(containerId: string, name: string): Promise<null | Readonly<Folder>>;
    getFolders(containerId: string): Promise<readonly Readonly<Folder>[]>;
    getModule(name: string): Promise<null | Readonly<Module>>;
    getModules(): Promise<readonly Readonly<Module>[]>;
    getProjectId(): Promise<string>;
    removeEventListener<K>(eventType: K, listener: EventHandler<{}, K>): void;
    renameFolder(folderId: string, newName: string): Promise<void>;
}

Hierarchy (view full)

Properties

_apiId

Methods

addEventListener addFolder deleteFolder getDocumentsInfo getFolder getFolders getModule getModules getProjectId removeEventListener renameFolder

Properties

_apiId

_apiId

Unique identifier that can be used to register or retrieve a specific API.

Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

Methods

addEventListener

  • addEventListener<K>(eventType, listener): DisposeListener

  • Adds an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to listen for.

    • listener: EventHandler<{}, K>

      The event listener to add.

    Returns DisposeListener

    A function that can be called to remove the event listener.

addFolder

  • addFolder(containerId, name): Promise<Readonly<Folder>>

  • Creates a new folder within a given container.

    Parameters

    • containerId: string

      The ID of the container to add the folder to.

    • name: string

      The name of the new folder.

    Returns Promise<Readonly<Folder>>

    Promise resolving to the created folder.

deleteFolder

  • deleteFolder(folderId): Promise<void>

  • Deletes a folder by its ID.

    Parameters

    • folderId: string

      The ID of the folder to delete.

    Returns Promise<void>

    Promise resolving when the folder has been deleted.

getDocumentsInfo

  • getDocumentsInfo(containerId): Promise<readonly Readonly<UnitInfo>[]>

  • Retrieves information about all documents within a given container.

    Parameters

    • containerId: string

      The ID of the container to get documents info from.

    Returns Promise<readonly Readonly<UnitInfo>[]>

    Promise resolving to a readonly array of document info objects.

getFolder

  • getFolder(containerId, name): Promise<null | Readonly<Folder>>

  • Retrieves a specific folder by name within a given container.

    Parameters

    • containerId: string

      The ID of the container to search in.

    • name: string

      The name of the folder to retrieve.

    Returns Promise<null | Readonly<Folder>>

    Promise resolving to the folder if found, or null otherwise.

getFolders

  • getFolders(containerId): Promise<readonly Readonly<Folder>[]>

  • Retrieves all folders within a given container (module or folder).

    Parameters

    • containerId: string

      The ID of the container to get folders from (module or folder).

    Returns Promise<readonly Readonly<Folder>[]>

    Promise resolving to a readonly array of folders.

getModule

  • getModule(name): Promise<null | Readonly<Module>>

  • Retrieves a specific module by its name.

    Parameters

    • name: string

      The name of the module to retrieve.

    Returns Promise<null | Readonly<Module>>

    Promise resolving to the module if found, or null otherwise.

getModules

  • getModules(): Promise<readonly Readonly<Module>[]>

  • Retrieves all modules in the project.

    Returns Promise<readonly Readonly<Module>[]>

    Promise resolving to a readonly array of modules.

getProjectId

  • getProjectId(): Promise<string>

  • Returns the unique identifier of the current project.

    Returns Promise<string>

    Promise resolving to the project ID as a string.

removeEventListener

  • removeEventListener<K>(eventType, listener): void

  • Removes an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to remove the listener from.

    • listener: EventHandler<{}, K>

      The event listener to remove.

    Returns void

renameFolder

  • renameFolder(folderId, newName): Promise<void>

  • Changes the name of a folder.

    Parameters

    • folderId: string

      The ID of the folder to rename.

    • newName: string

      The new name for the folder.

    Returns Promise<void>

    Promise resolving when the folder name has been changed.

Settings

On This Page

Properties
Methods