TeamFoundationTask Class
A task that can be added to the Task Service to run one time or on an interval basis on a pool of worker threads. When the task runs, the provided callback method is invoked.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.Framework.Server.Task.TeamFoundationTask<Guid>
Microsoft.TeamFoundation.Framework.Server.TeamFoundationTask
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
Public Class TeamFoundationTask _
Inherits TeamFoundationTask(Of Guid)
public class TeamFoundationTask : TeamFoundationTask<Guid>
public ref class TeamFoundationTask : public TeamFoundationTask<Guid>
type TeamFoundationTask =
class
inherit TeamFoundationTask<Guid>
end
public class TeamFoundationTask extends TeamFoundationTask<Guid>
The TeamFoundationTask type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
TeamFoundationTask(TeamFoundationTaskCallback) | Creates a TeamFoundationTask for the given callback method |
|
TeamFoundationTask(TeamFoundationTaskCallback, Object, Int32) | Creates a TeamFoundationTask with the specified arguments |
|
TeamFoundationTask(TeamFoundationTaskCallback, Object, DateTime, Int32) | Creates a TeamFoundationTask with the specified arguments |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Callback | The callback that should be invoked when the task is executed (Inherited from TeamFoundationTask<T>.) |
|
Identifier | Some identifier to figure out who owns this task (Inherited from TeamFoundationTask<T>.) |
|
Interval | The frequency the task should run for this schedule (measured in milliseconds) (Inherited from TeamFoundationTask<T>.) |
|
IsHighPriority | (Inherited from TeamFoundationTask<T>.) |
|
NeedsTargetRequestContext | (Overrides TeamFoundationTask<T>.NeedsTargetRequestContext.) |
|
ServicingContext | Flag indicating if this task should return a servicing or system context to the callback. (Inherited from TeamFoundationTask<T>.) |
|
StartTime | The first time the task should run (Inherited from TeamFoundationTask<T>.) |
|
TaskArgs | The arguments to pass to the task callback when it is invoked (Inherited from TeamFoundationTask<T>.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Returns true if the given task targets the same callback method (Inherited from TeamFoundationTask<T>.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Gets the hash code for the task (Inherited from TeamFoundationTask<T>.) |
|
GetRequestContext | (Overrides TeamFoundationTask<T>.GetRequestContext(TeamFoundationRequestContext, T).) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Pretty print this task (Inherited from TeamFoundationTask<T>.) |
Top
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.