Class JobBase

Namespace

The.Web.Jobs

Assembly

Instagile.Web.Client.dll

public abstract class JobBase : BackgroundService, IHostedService, IDisposable

Inheritance

object

BackgroundService

JobBase

Implements

IHostedService

IDisposable

Derived

ManualJobBase

MessageConsumerJobBase<T>

PeriodicJobBase

ScheduledJobBase

StartupJobBase

Inherited Members

BackgroundService.ExecuteAsync(CancellationToken)

BackgroundService.StartAsync(CancellationToken)

BackgroundService.StopAsync(CancellationToken)

BackgroundService.Dispose()

BackgroundService.ExecuteTask

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

JobBase(IServiceScopeFactory, ILogger, PermissionSet)

public JobBase(IServiceScopeFactory scopeFactory, ILogger logger, PermissionSet permissions)

Parameters

scopeFactory IServiceScopeFactory

logger ILogger

permissions PermissionSet

JobBase(JobParameters)

public JobBase(JobParameters parameters)

Parameters

parameters JobParameters

Properties

CanExecute

public virtual bool CanExecute { get; }

Property Value

bool

IsJobRunRecordingEnabled

public bool IsJobRunRecordingEnabled { get; set; }

Property Value

bool

JobRunProgressUpdateInterval

public TimeSpan JobRunProgressUpdateInterval { get; set; }

Property Value

TimeSpan

Logger

protected ILogger Logger { get; }

Property Value

ILogger

Name

public virtual string Name { get; }

Property Value

string

RunStatus

public CurrentStatus RunStatus { get; }

Property Value

CurrentStatus

RunningSince

public DateTime? RunningSince { get; }

Property Value

DateTime?

RunningUntil

public Task RunningUntil { get; }

Property Value

Task

Methods

CancelRun()

public void CancelRun()

DescribeJobParameters()

Creates a debug view of the data on which the job is currently operating.

protected virtual string DescribeJobParameters()

Returns

string

ExecuteJobAsync(IServices, IPrincipal, IProgress<Status>, CancellationToken)

Implements the actual job logic.

protected abstract Task ExecuteJobAsync(IServices services, IPrincipal principal, IProgress<Status> progress, CancellationToken cancellationToken)

Parameters

services IServices

principal IPrincipal

progress IProgress<Status>

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(IProgress<Status>, CancellationToken)

Run the job, recording results to an IProgress.

public Task ExecuteOnceAsync(IProgress<Status> progress, CancellationToken cancellationToken)

Parameters

progress IProgress<Status>

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(IProgress<Status>, IPrincipal?, CancellationToken)

Run the job, recording results to an IProgress.

public Task ExecuteOnceAsync(IProgress<Status> progress, IPrincipal? user, CancellationToken cancellationToken)

Parameters

progress IProgress<Status>

user IPrincipal

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(CancellationToken)

Run the job, recording results to a JobRun if enabled.

public Task ExecuteOnceAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(IPrincipal, CancellationToken)

Run the job, recording results to a JobRun if enabled.

public Task ExecuteOnceAsync(IPrincipal asUser, CancellationToken cancellationToken)

Parameters

asUser IPrincipal

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(Identity, CancellationToken)

Run the job, recording results to a JobRun if enabled.

public Task ExecuteOnceAsync(Identity startedBy, CancellationToken cancellationToken)

Parameters

startedBy Identity

cancellationToken CancellationToken

Returns

Task

ExecuteOnceAsync(Identity?, IPrincipal?, CancellationToken)

Run the job, recording results to a JobRun if enabled.

public Task ExecuteOnceAsync(Identity? startedBy, IPrincipal? asUser, CancellationToken cancellationToken)

Parameters

startedBy Identity

asUser IPrincipal

cancellationToken CancellationToken

Returns

Task