Docs for m2-core, m2-components
  1. Injectables
  2. BackgroundService

File

projects/m2-core/src/lib/core/service/system/background.service.ts

Index

Methods

Constructor

constructor(tabService: TabService, notificationService: NotificationService)
Parameters :
Name Type Optional
tabService TabService No
notificationService NotificationService No

Methods

Public getBackgroundTask
getBackgroundTask(clientWorkId: string)
Parameters :
Name Type Optional
clientWorkId string No
Returns : WorkInfo
Public getBackgroundTasks
getBackgroundTasks()

Client tasks API

Returns : WorkInfo[]
Public registerTask
registerTask(workInfo: WorkInfo)
Parameters :
Name Type Optional
workInfo WorkInfo No
Returns : void
Public runInBackground
runInBackground(task: () => void, taskName: string, taskStartedMsg?: string, isUnique?: boolean)
Type parameters :
  • R

Task progress is dummy incremented using interval

Parameters :
Name Type Optional
task function No
taskName string No
taskStartedMsg string Yes
isUnique boolean Yes
Returns : Promise<R>
Public unregisterTask
unregisterTask(workInfo: WorkInfo)
Parameters :
Name Type Optional
workInfo WorkInfo No
Returns : void

results matching ""

    No results matching ""