@acceleratxr/core_sdk / AssetService
Class: AssetService#
Hierarchy#
-
↳ AssetService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new AssetService(apiClient: ApiClient, config: Configuration): AssetService
Overrides ServiceBase.constructor
Defined in src/services/AssetService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: AssetService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “d3141b12-adcb-47f5-9687-2950264c1e8b”
Defined in src/services/AssetService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/AssetService.ts:74
Returns the count of assets
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(form: FormData): Promise<Asset[] | undefined>
Defined in src/services/AssetService.ts:34
Uploads file(s) in the given form data and creates new assets.
Parameters:#
Name |
Type |
|---|---|
|
FormData |
Returns: Promise<Asset[] | undefined>
delete#
▸ delete(id: string, version?: string | number, purge?: undefined | false | true): Promise<void>
Defined in src/services/AssetService.ts:109
Deletes the asset
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string | number |
|
undefined | false | true |
Returns: Promise<void>
download#
▸ download(id: string, version?: string | number): Promise<any>
Defined in src/services/AssetService.ts:128
Downloads the asset
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string | number |
Returns: Promise<any>
findAll#
▸ findAll(query?: any): Promise<Asset[] | undefined>
Defined in src/services/AssetService.ts:22
Returns all assets from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Asset[] | undefined>
findById#
▸ findById(id: string, version?: string | number): Promise<Asset | undefined>
Defined in src/services/AssetService.ts:93
Returns a single asset from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string | number |
Returns: Promise<Asset | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/AssetService.ts:62
Deletes all assets from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>