Home > @uniformdev/project-map > ProjectMapClient

ProjectMapClient class

Signature:

Extends: ApiClient<ProjectMapClientOptions>

Constructors

<table><thead><tr><th>

Constructor

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

(constructor)(options)

</td><td>

</td><td>

Constructs a new instance of the ProjectMapClient class

</td></tr> </tbody></table>

Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

deleteProjectMap

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapDeleteRequest>) => Promise<void>

</td><td>

Delete a project map definition

</td></tr> <tr><td>

deleteProjectMapNode

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapNodeDeleteRequest>) => Promise<void>

</td><td>

Delete a project map node

</td></tr> <tr><td>

getNodes

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapNodeGetRequest>

</td><td>

Get a subtree of the project map tree returned in a list format

</td></tr> <tr><td>

getProjectMapDefinition

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapGetRequest>) => Promise<{ projectMaps: { id?: string | undefined; name: string; description?: string | undefined; baseUrl?: string | undefined; default?: boolean | undefined; }[]; }>

</td><td>

Get specific project map definition

</td></tr> <tr><td>

getProjectMapDefinitions

</td><td>

</td><td>

() => Promise<{ projectMaps: { id?: string | undefined; name: string; description?: string | undefined; baseUrl?: string | undefined; default?: boolean | undefined; }[]; }>

</td><td>

Get available project map defintions

</td></tr> <tr><td>

getSubtree

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapNodeGetRequest>) => Promise<ProjectMapSubtree | undefined>

</td><td>

Get a subtree of the project map tree returned in a tree format

</td></tr> <tr><td>

upsertProjectMap

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapUpsertRequest>) => Promise<string>

</td><td>

Update or insert a project map definition

</td></tr> <tr><td>

upsertProjectMapNodes

</td><td>

</td><td>

(options: WithoutProjectId<ProjectMapNodeUpsertRequest>) => Promise<void>

</td><td>

Update or insert a list of project map nodes

</td></tr> </tbody></table>