Interface IProjectApi

_apiId

addEventListener

• addEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): 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: string, name: string): 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: string): 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: string): 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: string, name: string): 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: string): 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: string): 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 extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): 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: string, newName: string): 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.