Home > @uniformdev/project-map > ProjectMapClient
ProjectMapClient class
Signature:
Extends: ApiClient<ProjectMapClientOptions>
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the <code>ProjectMapClient</code> class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| deleteProjectMap | (options: WithoutProjectId<ProjectMapDeleteRequest>) => Promise<void> | Delete a project map definition | |
| deleteProjectMapNode | (options: WithoutProjectId<ProjectMapNodeDeleteRequest>) => Promise<void> | Delete a project map node | |
| getNodes | (options: WithoutProjectId<ProjectMapNodeGetRequest> | Get a subtree of the project map tree returned in a list format | |
| getProjectMapDefinition | (options: WithoutProjectId<ProjectMapGetRequest>) => Promise<{ projectMaps: { id?: string | undefined; name: string; description?: string | undefined; baseUrl?: string | undefined; default?: boolean | undefined; }[]; }> | Get specific project map definition | |
| getProjectMapDefinitions | () => Promise<{ projectMaps: { id?: string | undefined; name: string; description?: string | undefined; baseUrl?: string | undefined; default?: boolean | undefined; }[]; }> | Get available project map defintions | |
| getSubtree | (options: WithoutProjectId<ProjectMapNodeGetRequest>) => Promise<ProjectMapSubtree | undefined> | Get a subtree of the project map tree returned in a tree format | |
| upsertProjectMap | (options: WithoutProjectId<ProjectMapUpsertRequest>) => Promise<string> | Update or insert a project map definition | |
| upsertProjectMapNodes | (options: WithoutProjectId<ProjectMapNodeUpsertRequest>) => Promise<void> | Update or insert a list of project map nodes |