Partager via


DefinitionsController Class

Controller to handle all REST calls against build definitions

Inheritance Hierarchy

System.Object
  System.Web.Http.ApiController
    Microsoft.TeamFoundation.Framework.Server.TfsApiController
      Microsoft.TeamFoundation.Build.Server.Rest.DefinitionsController

Namespace:  Microsoft.TeamFoundation.Build.Server.Rest
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

'Declaration
<ControllerApiVersionAttribute()> _
<VersionedApiControllerCustomNameAttribute(Area := "Build", ResourceName := "Definitions")> _
Public Class DefinitionsController _
    Inherits TfsApiController
[ControllerApiVersionAttribute()]
[VersionedApiControllerCustomNameAttribute(Area = "Build", ResourceName = "Definitions")]
public class DefinitionsController : TfsApiController
[ControllerApiVersionAttribute()]
[VersionedApiControllerCustomNameAttribute(Area = L"Build", ResourceName = L"Definitions")]
public ref class DefinitionsController : public TfsApiController
[<ControllerApiVersionAttribute()>]
[<VersionedApiControllerCustomNameAttribute(Area = "Build", ResourceName = "Definitions")>]
type DefinitionsController =  
    class 
        inherit TfsApiController 
    end
public class DefinitionsController extends TfsApiController

The DefinitionsController type exposes the following members.

Constructors

  Name Description
Public method DefinitionsController

Top

Properties

  Name Description
Public property BaseHttpExceptions (Inherited from TfsApiController.)
Public property Configuration (Inherited from ApiController.)
Public property ControllerContext (Inherited from ApiController.)
Public property HttpExceptions (Overrides TfsApiController.HttpExceptions.)
Public property ModelState (Inherited from ApiController.)
Public property Request (Inherited from ApiController.)
Public property RequestContext The Setter is only for Unit testing purposes (Inherited from TfsApiController.)
Public property TraceArea (Overrides TfsApiController.TraceArea.)
Public property Url (Inherited from ApiController.)
Public property User (Inherited from ApiController.)

Top

Methods

  Name Description
Public method DeleteBuildDefinition Deletes the build definition with id definitionId
Public method Dispose() (Inherited from ApiController.)
Protected method Dispose(Boolean) (Inherited from ApiController.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method ExecuteAsync (Inherited from ApiController.)
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.)
Public method GetDefinitionById Gets the build definition with id definitionId
Public method GetDefinitions Gets all build definitions that fit the specific filter params
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Initialize (Inherited from TfsApiController.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

  Name Description
Public Extension Method GenerateResponse (Defined by TfsApiControllerExtensions.)

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.

See Also

Reference

Microsoft.TeamFoundation.Build.Server.Rest Namespace