How to start BackgroundTask from code

[vitalybrandes]

I saw this somewhere and cannot find :-(
How to start BackgroundTask from code?

[hishamco]

Simply you can create your task by implementing the OrchardCore.BackgroundTasks.IBackgroundTask

[vitalybrandes]

Do you know maybe where to find some sample code?

[hishamco]

Try to check Demo module, also try to search in the source, the DoWorkAsync() should be called somewhere

[vitalybrandes]

didnt find any demo :-(

[hishamco]

This is how it called in ModularBackgroundService

OrchardCore/src/OrchardCore/OrchardCore/Modules/ModularBackgroundService.cs

Line 126 in 943f502

await task.DoWorkAsync(scope.ServiceProvider, stoppingToken);

[vitalybrandes]

Thank you!

[dodyg]

How does one enable the background task without relying on admin interface? Is there anyway to enable it via code?

[deanmarcussen]

Just apply the background task attribute with a schedule @dodyg

OrchardCore/src/OrchardCore.Modules/OrchardCore.AuditTrail/Services/AuditTrailBackgroundTask.cs

Lines 14 to 17 in 3e03ed2

	[BackgroundTask(Schedule = "0 0 * * *",
	Description = "A background task that regularly deletes old Audit Trail Events.",
	LockTimeout = 3_000, LockExpiration = 30_000)]

(and register the service)

The ui is mostly for editing the schedule, but if you are doing it by code, no need.

[dodyg]

Thanks!

[dodyg]

Hmm..is there anything else I need to enable from code? I created a dummy background service and it never got executed.

This is the host Startup.cs

[dodyg]

The problem is if I change the host Startup.cs to

        public void ConfigureServices(IServiceCollection services)
        {
            Conf.Emails(services, _config);
            services.AddMemoryCache();
            services.AddOrchardCore(x =>
           {
               x.AddBackgroundService();
           }).AddMvc();
            services.AddImageSharp();
        }

The module stops working without showing any exception.

[dodyg]

Ok this works

        public void ConfigureServices(IServiceCollection services)
        {
            Conf.Emails(services, _config);
            services.AddMemoryCache();
            services.AddOrchardCore()
                .AddBackgroundService()
                .AddMvc();

            services.AddImageSharp();
        }