ScheduledJob Class

Article
05/25/2016

Provides a base class for scheduled jobs to be executed as part of the service.

Namespace: Microsoft.WindowsAzure.Mobile.Service
Assembly: Microsoft.WindowsAzure.Mobile.Service (in Microsoft.WindowsAzure.Mobile.Service.dll)

Inheritance Hierarchy

System.Object
Microsoft.WindowsAzure.Mobile.Service.ScheduledJob

Syntax

public abstract class ScheduledJob : IScheduledJob, IDisposable

public ref class ScheduledJob abstract : IScheduledJob, IDisposable

[<AbstractClass>]
type ScheduledJob = 
    class
        interface IScheduledJob
        interface IDisposable
    end

Public MustInherit Class ScheduledJob
    Implements IScheduledJob, IDisposable

Constructors

	Name	Description
	ScheduledJob()	Creates a new instance of the ScheduledJob class.

Properties

	Name	Description
	CancellationToken	Gets a CancellationToken indicating whether the scheduled job has been cancelled. Scheduled jobs that run for an extended amount of time should listen to this token to see if they are being cancelled.
	Services	Gets or sets the ApiServices associated with this ScheduledJob.

Methods

	Name	Description
	Dispose()	Releases the unmanaged resources and disposes of the managed resources used by this ScheduledJob instance. When the job completes this method is called automatically by the infrastructure.
	Dispose(Boolean)	Releases the unmanaged resources used by this ScheduledJob instance and optionally disposes of the managed resources. Override this method to dispose additional resources specific to this particular ScheduledJob implementation.
	Equals(Object)	(Inherited from Object.)
	ExecuteAsync()	When implemented in a derived class, executes the scheduled job asynchronously. Implementations that want to know whether the scheduled job is being cancelled can get a CancellationToken from the M:CancellationToken property.
	ExecuteAsync(ScheduledJobDescriptor, CancellationToken)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Initialize(ScheduledJobDescriptor, CancellationToken)	Initializes this ScheduledJob before execution begins.
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via