@acceleratxr/core_sdk / ReportStorageLocationService

Class: ReportStorageLocationService

Hierarchy

• ServiceBase

  ↳ ReportStorageLocationService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• create

• createMany

• delete

• findAll

• findById

• truncate

• update

• updateMany

Constructors

constructor

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

Overrides ServiceBase.constructor

Defined in src/services/ReportStorageLocationService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: ReportStorageLocationService

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 = “5d74f0b7-3add-4e0c-8827-55f32dadb2a3”

Defined in src/services/ReportStorageLocationService.ts:16

Methods

count

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

Defined in src/services/ReportStorageLocationService.ts:69

Returns the count of storage locations

Parameters:

Name	Type
query?	any

Returns: Promise<number>

---

create

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

Defined in src/services/ReportStorageLocationService.ts:33

Create a new storage location.

Parameters:

Name	Type
obj	ReportStorageLocation

Returns: Promise<ReportStorageLocation | undefined>

---

createMany

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

Defined in src/services/ReportStorageLocationService.ts:45

Create multiple new storage locations.

Parameters:

Name	Type
objs	ReportStorageLocation[]

Returns: Promise<ReportStorageLocation[] | undefined>

---

delete

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

Defined in src/services/ReportStorageLocationService.ts:126

Deletes the storage location

Parameters:

Name	Type
id	string

Returns: Promise<void>

---

findAll

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

Defined in src/services/ReportStorageLocationService.ts:21

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

Parameters:

Name	Type
query?	any

Returns: Promise<ReportStorageLocation[] | undefined>

---

findById

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

Defined in src/services/ReportStorageLocationService.ts:88

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

Parameters:

Name	Type
id	string

Returns: Promise<ReportStorageLocation | undefined>

---

truncate

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

Defined in src/services/ReportStorageLocationService.ts:57

Deletes all storage locations from the service.

Parameters:

Name	Type
query?	any

Returns: Promise<void>

---

update

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

Defined in src/services/ReportStorageLocationService.ts:101

Updates a single storage location

Parameters:

Name	Type
id	string
obj	ReportStorageLocation

Returns: Promise<ReportStorageLocation | undefined>

---

updateMany

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

Defined in src/services/ReportStorageLocationService.ts:114

Updates multiple storage locations.

Parameters:

Name	Type
objs	ReportStorageLocation[]

Returns: Promise<ReportStorageLocation[] | undefined>