Interface ProjectAPI

The API for operations related to Trimble Connect projects.

Hierarchy

ProjectAPI

Index

Methods

Methods

getCurrentProject

getCurrentProject(): Promise<ConnectProject>

Get the current project details from the Trimble Connect project extension.

deprecated
Use ProjectAPI.getProject instead.

Returns Promise<ConnectProject>
The awaitable task

getMembers

getMembers(): Promise<UserDetails[]>

Gets the current project members asynchronously.

Returns Promise<UserDetails[]>
The awaitable task that returns the current project members.

getProject

getProject(): Promise<ConnectProject>

Gets the current Trimble Connect project asynchronously.

Returns Promise<ConnectProject>
The awaitable task that returns the current Trimble Connect project.

getSettings

getSettings(): Promise<ProjectSettings>

Gets the current project settings asynchronously.

Returns Promise<ProjectSettings>
The awaitable task that returns the current project settings.

setProject

setProject(projectId: string): Promise<void>

Sets the current Trimble Connect project asynchronously.

Parameters
- projectId: string
  
  The project identifier
Returns Promise<void>
The awaitable task.