@acceleratxr/core_sdk / AssetStorageLocationService

Class: AssetStorageLocationService

Hierarchy

• ServiceBase

  ↳ AssetStorageLocationService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• create

• createMany

• delete

• findAll

• findById

• truncate

• update

• updateMany

Constructors

constructor

+ new AssetStorageLocationService(apiClient: ApiClient, config: Configuration): AssetStorageLocationService

Overrides ServiceBase.constructor

Defined in src/services/AssetStorageLocationService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: AssetStorageLocationService

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 = “8acd6c69-3683-447b-b0e2-b8c3ffe6b38f”

Defined in src/services/AssetStorageLocationService.ts:16

Methods

count

▸ count(query?: any): Promise<number>

Defined in src/services/AssetStorageLocationService.ts:69

Returns the count of storage locations

Parameters:

Name	Type
query?	any

Returns: Promise<number>

---

create

▸ create(obj: AssetStorageLocation): Promise<AssetStorageLocation | undefined>

Defined in src/services/AssetStorageLocationService.ts:33

Create a new storage location.

Parameters:

Name	Type
obj	AssetStorageLocation

Returns: Promise<AssetStorageLocation | undefined>

---

createMany

▸ createMany(objs: AssetStorageLocation[]): Promise<AssetStorageLocation[] | undefined>

Defined in src/services/AssetStorageLocationService.ts:45

Create multiple new storage locations.

Parameters:

Name	Type
objs	AssetStorageLocation[]

Returns: Promise<AssetStorageLocation[] | undefined>

---

delete

▸ delete(id: string): Promise<void>

Defined in src/services/AssetStorageLocationService.ts:126

Deletes the storage location

Parameters:

Name	Type
id	string

Returns: Promise<void>

---

findAll

▸ findAll(query?: any): Promise<AssetStorageLocation[] | undefined>

Defined in src/services/AssetStorageLocationService.ts:21

Returns all storage locations from the system that the user has access to

Parameters:

Name	Type
query?	any

Returns: Promise<AssetStorageLocation[] | undefined>

---

findById

▸ findById(id: string): Promise<AssetStorageLocation | undefined>

Defined in src/services/AssetStorageLocationService.ts:88

Returns a single storage location from the system that the user has access to

Parameters:

Name	Type
id	string

Returns: Promise<AssetStorageLocation | undefined>

---

truncate

▸ truncate(query?: any): Promise<void>

Defined in src/services/AssetStorageLocationService.ts:57

Deletes all storage locations from the service.

Parameters:

Name	Type
query?	any

Returns: Promise<void>

---

update

▸ update(id: string, obj: AssetStorageLocation): Promise<AssetStorageLocation | undefined>

Defined in src/services/AssetStorageLocationService.ts:101

Updates a single storage location

Parameters:

Name	Type
id	string
obj	AssetStorageLocation

Returns: Promise<AssetStorageLocation | undefined>

---

updateMany

▸ updateMany(objs: AssetStorageLocation[]): Promise<AssetStorageLocation[] | undefined>

Defined in src/services/AssetStorageLocationService.ts:114

Updates multiple storage locations.

Parameters:

Name	Type
objs	AssetStorageLocation[]

Returns: Promise<AssetStorageLocation[] | undefined>