@acceleratxr/core_sdk / ReportService
Class: ReportService#
Hierarchy#
-
↳ ReportService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ReportService(apiClient: ApiClient, config: Configuration): ReportService
Overrides ServiceBase.constructor
Defined in src/services/ReportService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ReportService
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 = “8e1783f7-bd28-4295-80fe-643fe866147c”
Defined in src/services/ReportService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ReportService.ts:69
Returns the count of reports
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(form: FormData): Promise<Report | undefined>
Defined in src/services/ReportService.ts:34
Uploads the given form data and creates a new report.
Parameters:#
Name |
Type |
|---|---|
|
FormData |
Returns: Promise<Report | undefined>
delete#
▸ delete(id: string, version?: string | number, purge?: undefined | false | true): Promise<void>
Defined in src/services/ReportService.ts:104
Deletes the report
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string | number |
|
undefined | false | true |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Report[] | undefined>
Defined in src/services/ReportService.ts:22
Returns all reports from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Report[] | undefined>
findById#
▸ findById(id: string, version?: string | number): Promise<Report | undefined>
Defined in src/services/ReportService.ts:88
Returns a single report from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string | number |
Returns: Promise<Report | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/ReportService.ts:57
Deletes all reports from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>