Class MinimapLevelService

Minimap Level operations.

Implements

MinimapLevelServiceInterface

Index

Constructors

Methods

createMinimapLevel deleteMinimapLevel getMinimapLevels refreshMinimapLevels setMinimapLevelCameraPosition updateMinimapLevel

Constructors

constructor

new MinimapLevelService(
    connectClient: ConnectClientInterface,
    minimapLevelMapper: MinimapLevelMapper,
    parentId: AssetInstanceId,
): MinimapLevelService
Constructor for MinimapLevelService.
Parameters
- connectClient: ConnectClientInterface
  Connect client to make API calls from the Connect SDK
- minimapLevelMapper: MinimapLevelMapper
  Mapper to map minimapLevel API response to minimapLevel object.
- parentId: AssetInstanceId
Returns MinimapLevelService
Remarks
It is easier to use the MinimapLevelServiceFactory to create an instance of this class as it will inject the required dependencies.
- Defined in service/minimapLevelService.ts:50

Methods

createMinimapLevel

createMinimapLevel(
variables: { data: MinimapLevelData; order?: number; title: string },
): Promise<CreateMinimapLevelResult>
Update a minimap level.
Parameters
- variables: { data: MinimapLevelData; order?: number; title: string }
Returns Promise<CreateMinimapLevelResult>
Implementation of MinimapLevelServiceInterface.createMinimapLevel
- Defined in service/minimapLevelService.ts:126

deleteMinimapLevel

deleteMinimapLevel(
id: AssetMinimapLevel.MinimapLevelId,
): Promise<DeleteMinimapLevelResult>
Delete a minimapLevel by its id.
Parameters
- id: AssetMinimapLevel.MinimapLevelId
Returns Promise<DeleteMinimapLevelResult>
Implementation of MinimapLevelServiceInterface.deleteMinimapLevel
- Defined in service/minimapLevelService.ts:102

getMinimapLevels

getMinimapLevels(pageNumber?: number): Promise<GetMinimapLevelResult>
Load minimapLevels by its parent asset id.
Parameters
- OptionalpageNumber: number
Returns Promise<GetMinimapLevelResult>
Implementation of MinimapLevelServiceInterface.getMinimapLevels
- Defined in service/minimapLevelService.ts:77

refreshMinimapLevels

refreshMinimapLevels(pageNumber?: number): Promise<RefreshMinimapLevelResult>
Refreshes the minimapLevels with the given id from the server. This will not return the minimapLevels, but will update the cache.
Parameters
- OptionalpageNumber: number
Returns Promise<RefreshMinimapLevelResult>
Implementation of MinimapLevelServiceInterface.refreshMinimapLevels
- Defined in service/minimapLevelService.ts:60

setMinimapLevelCameraPosition

setMinimapLevelCameraPosition(
id: AssetMinimapLevel.MinimapLevelId,
variables: { viewpoint?: MinimapLevelViewpoint },
): Promise<SetMinimapLevelViewpointResult>
Updated the asset view point (default camera position).
Parameters
- id: AssetMinimapLevel.MinimapLevelId
- variables: { viewpoint?: MinimapLevelViewpoint }
Returns Promise<SetMinimapLevelViewpointResult>
Implementation of MinimapLevelServiceInterface.setMinimapLevelCameraPosition
- Defined in service/minimapLevelService.ts:191

updateMinimapLevel

updateMinimapLevel(
id: AssetMinimapLevel.MinimapLevelId,
variables: { data?: MinimapLevelData; order?: number; title?: string },
): Promise<UpdateMinimapLevelResult>
Update a a minimap level.
Parameters
- id: AssetMinimapLevel.MinimapLevelId
- variables: { data?: MinimapLevelData; order?: number; title?: string }
Returns Promise<UpdateMinimapLevelResult>
Implementation of MinimapLevelServiceInterface.updateMinimapLevel
- Defined in service/minimapLevelService.ts:159