Class AssetStorageService

Hierarchy

BaseService
- AssetStorageService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AssetStorageService(options: IRocosClientOptions): AssetStorageService

Inherited from BaseService.constructor
- Defined in src/services/base-service.ts:9
Parameters
- options: IRocosClientOptions
Returns AssetStorageService

Properties

Protected httpRequest

httpRequest: HttpRequest

Protected options

options: IRocosClientOptions

Methods

create

create(projectId: string, filePath: string, file: File): Observable<any>

- Defined in src/services/asset-storage-service.ts:14
Create a new project asset

Parameters
- projectId: string
- filePath: string
- file: File
Returns Observable<any>

delete

delete(projectId: string, filePath: string): Observable<any>

- Defined in src/services/asset-storage-service.ts:47
Delete a project asset

Parameters
- projectId: string
- filePath: string
Returns Observable<any>

getAsset

getAsset(projectId: string, filePath: string): Observable<any>

- Defined in src/services/asset-storage-service.ts:107
Get a project asset

Parameters
- projectId: string
- filePath: string
Returns Observable<any>

getProfileSyncDefinition

getProfileSyncDefinition(projectId: string, profileId: string): Observable<RocosResponse<AssetSyncDefinitionsModel>>

- Defined in src/services/asset-storage-service.ts:182
Get Profile Sync Definitions

Parameters
- projectId: string
- profileId: string
Returns Observable<RocosResponse<AssetSyncDefinitionsModel>>

getRobotSyncDefinitions

getRobotSyncDefinitions(projectId: string, callsign: string): Observable<RocosResponse<AssetSyncDefinitionsModel>>

- Defined in src/services/asset-storage-service.ts:147
Get Robot Sync Definitions

Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<AssetSyncDefinitionsModel>>

list

list(projectId: string, filePath?: string): Observable<any>

- Defined in src/services/asset-storage-service.ts:56
List assets for a project or project file path

Parameters
- projectId: string
- Optional filePath: string
Returns Observable<any>

listFlowAssets

listFlowAssets(projectId: string, flowId: string, flowInstance: string, parent?: string, includeSignedUrl?: boolean): Observable<RocosResponse<AssetItemModel[]>>

- Defined in src/services/asset-storage-service.ts:71
List assets for a flow

Parameters
- projectId: string
- flowId: string
- flowInstance: string
- Default value parent: string = "/"
- Default value includeSignedUrl: boolean = false
Returns Observable<RocosResponse<AssetItemModel[]>>

listRobotAssets

listRobotAssets(projectId: string, callsign: string, parent?: string, includeSignedUrl?: boolean): Observable<RocosResponse<AssetItemModel[]>>

- Defined in src/services/asset-storage-service.ts:91
List assets for a robot

Parameters
- projectId: string
- callsign: string
- Default value parent: string = "/"
- Default value includeSignedUrl: boolean = false
Returns Observable<RocosResponse<AssetItemModel[]>>

setProfileSyncDefinitions

setProfileSyncDefinitions(projectId: string, profileId: string, definitions: AssetSyncDefinitionsModel): Observable<RocosResponse<AssetSyncDefinitionsModel>>

- Defined in src/services/asset-storage-service.ts:160
Set Profile Sync Definitions

Parameters
- projectId: string
- profileId: string
- definitions: AssetSyncDefinitionsModel
Returns Observable<RocosResponse<AssetSyncDefinitionsModel>>

setRobotSyncDefinitions

setRobotSyncDefinitions(projectId: string, callsign: string, definitions: AssetSyncDefinitionsModel, syncNow?: boolean): Observable<RocosResponse<AssetSyncDefinitionsModel>>

- Defined in src/services/asset-storage-service.ts:121
Set Robot Sync Definitions

Parameters
- projectId: string
- callsign: string
- definitions: AssetSyncDefinitionsModel
- Default value syncNow: boolean = false
  
  Runs file synchronisation immediately - will fail if the robot is not online
Returns Observable<RocosResponse<AssetSyncDefinitionsModel>>

update

update(projectId: string, filePath: string, file: File): Observable<any>

- Defined in src/services/asset-storage-service.ts:31
Update a project asset

Parameters
- projectId: string
- filePath: string
- file: File
Returns Observable<any>

Generated using TypeDoc