Web SDK documentation
  1. Injectables
  2. ReportsService

File

reports/reports.service.ts

Index

Properties
Methods

Constructor

constructor(alertService: AlertService, inventoryService: InventoryService, client: FetchClient, translateService: TranslateService)
Parameters :
Name Type Optional
alertService AlertService No
inventoryService InventoryService No
client FetchClient No
translateService TranslateService No

Methods

Async addSchedule
addSchedule(schedule: Schedule, exportId: IdReference)
Parameters :
Name Type Optional
schedule Schedule No
exportId IdReference No
Returns : unknown
Async deleteSchedule
deleteSchedule(schedule: Schedule, exportId: IdReference)
Parameters :
Name Type Optional
schedule Schedule No
exportId IdReference No
Returns : unknown
extractScheduleListFromExport
extractScheduleListFromExport(exp: Export)
Parameters :
Name Type Optional
exp Export No
Returns : any
Async fallbackConfigurationRemoval
fallbackConfigurationRemoval(config: IIdentified)
Parameters :
Name Type Optional
config IIdentified No
Returns : Promise<IFetchResponse>
Async getExport
getExport(exportId: IdReference)
Parameters :
Name Type Optional
exportId IdReference No
Returns : unknown
Async getScheduleList
getScheduleList(exportId: IdReference)
Parameters :
Name Type Optional
exportId IdReference No
Returns : unknown
Async normalConfigurationRemoval
normalConfigurationRemoval(config: IIdentified)
Parameters :
Name Type Optional
config IIdentified No
Returns : Promise<IFetchResponse>
Async removeConfiguration
removeConfiguration(config: IIdentified)

Removes report configuration.

Note: fallback strategy is based on error code returned by backend in case of missing subscription for report-agent microservice.

Parameters :
Name Type Optional Description
config IIdentified No

entity of report configuration
Returns : Promise<IFetchResponse>

Response wrapped in [[IFetchResponse]]
Async reschedule
reschedule(exportId: IdReference)
Parameters :
Name Type Optional
exportId IdReference No
Returns : unknown
Async updateSchedule
updateSchedule(oldSchedule: Schedule, schedule: Schedule, exportId: IdReference)
Parameters :
Name Type Optional
oldSchedule Schedule No
schedule Schedule No
exportId IdReference No
Returns : unknown
Async updateSchedules
updateSchedules(exportId: IdReference, schedulesToRemove: Schedule[], schedulesToAdd: Schedule[])
Parameters :
Name Type Optional Default value
exportId IdReference No
schedulesToRemove Schedule[] No []
schedulesToAdd Schedule[] No []
Returns : unknown

Properties

headers
Type : any
isReportAgentSubscribed
Type : boolean
microserviceUrl
Type : string
REPORT_AGENT_NOT_SUBSCRIBED_EXPECTED_ERROR_LOWER_CASE
Type : string

results matching ""

    No results matching ""