BuildWebService4 Class
Inheritance Hierarchy
System.Object
System.ComponentModel.MarshalByValueComponent
System.Web.Services.WebService
Microsoft.TeamFoundation.Server.Core.WebServices.TeamFoundationWebService
Microsoft.TeamFoundation.Build.Server.BuildWebServiceBase
Microsoft.TeamFoundation.Build.Server.BuildWebService4
Namespace: Microsoft.TeamFoundation.Build.Server
Assembly: Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)
Syntax
'Declaration
<ClientServiceAttribute(ComponentName := "TeamBuild", RegistrationName := "Build", _
ServiceName := "BuildService4", CollectionServiceIdentifier := "AAE1325C-E97F-4A15-B557-9D1620D5D5F4")> _
<WebServiceAttribute(Name := "BuildService", Namespace := "https://schemas.microsoft.com/TeamFoundation/2010/Build")> _
Public NotInheritable Class BuildWebService4 _
Inherits BuildWebServiceBase
[ClientServiceAttribute(ComponentName = "TeamBuild", RegistrationName = "Build",
ServiceName = "BuildService4", CollectionServiceIdentifier = "AAE1325C-E97F-4A15-B557-9D1620D5D5F4")]
[WebServiceAttribute(Name = "BuildService", Namespace = "https://schemas.microsoft.com/TeamFoundation/2010/Build")]
public sealed class BuildWebService4 : BuildWebServiceBase
[ClientServiceAttribute(ComponentName = L"TeamBuild", RegistrationName = L"Build",
ServiceName = L"BuildService4", CollectionServiceIdentifier = L"AAE1325C-E97F-4A15-B557-9D1620D5D5F4")]
[WebServiceAttribute(Name = L"BuildService", Namespace = L"https://schemas.microsoft.com/TeamFoundation/2010/Build")]
public ref class BuildWebService4 sealed : public BuildWebServiceBase
[<Sealed>]
[<ClientServiceAttribute(ComponentName = "TeamBuild", RegistrationName = "Build",
ServiceName = "BuildService4", CollectionServiceIdentifier = "AAE1325C-E97F-4A15-B557-9D1620D5D5F4")>]
[<WebServiceAttribute(Name = "BuildService", Namespace = "https://schemas.microsoft.com/TeamFoundation/2010/Build")>]
type BuildWebService4 =
class
inherit BuildWebServiceBase
end
public final class BuildWebService4 extends BuildWebServiceBase
The BuildWebService4 type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
BuildWebService4 |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Application | Gets the application object for the current HTTP request. (Inherited from WebService.) |
|
Container | Gets the container for the component. (Inherited from MarshalByValueComponent.) |
|
Context | Gets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.) |
|
DesignMode | Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.) |
|
Server | Gets the HttpServerUtility for the current request. (Inherited from WebService.) |
|
Session | Gets the HttpSessionState instance for the current request. (Inherited from WebService.) |
|
Site | Gets or sets the site of the component. (Inherited from MarshalByValueComponent.) |
|
SoapVersion | Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.) |
|
User | Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddBuildDefinitions | Adds the BuildDefinition objects to the server. If the URI field is entered before being sent to the server, then it will be ignored. Duplicate build definitions cannot exist at the same path. Therefore, an exception may be thrown if this case is encountered. The add is transactional across all definitions in such a way that if one add fails then the whole add fails. |
|
AddBuildQualities | Adds the list of qualities to the target team project. The user performing the add must have the EditBuildStatus permission in order to perform the action. |
|
AddProcessTemplates | |
|
CreateTeamProjectComponents | Creates the components that are required for having a team project. |
|
DeleteBuildDefinitions | Deletes build definitions from the server that have URIs equivalent to those that are passed in as the array parameter. Definitions that still have builds associated with them, whether they are completed or queued and in the 'Active', 'Postponed', or 'InProgress' state, cannot be deleted. The dependent builds must be deleted before removing the definition. |
|
DeleteBuildQualities | Deletes the specified build qualities from the target team project. The user performing this action must have the EditBuildStatus permission on the team project. |
|
DeleteBuilds | Deletes the builds that correspond to the given URIs. If a given build does not exist, then it is silently ignored. If this method does not throw any exceptions, then it can be assumed that the Build part of the delete went okay. Non-fatal errors such as test result deletion failures—other than permission problems—and drop-location access issues are just logged to the event log and are not considered errors. |
|
DeleteProcessTemplates | |
|
DestroyBuilds | Destroys the builds that correspond to the given URIs. If a given build does not exist, then it is silently ignored. |
|
Dispose | Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
GetAffectedBuildDefinitions | Determines which, if any, build definitions are affected by the provided server items. |
|
GetBuildQualities | Retrieves the build qualities that exist for the target team project. The user must have the GenericRead permission on the target team project in order to view the build qualities. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetService | Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
NotifyBuildCompleted | Notify the server that the build with the provided URI has completed. |
|
QueryBuildDefinitions | |
|
QueryBuildDefinitionsByUri | Queries for build definitions given a set of URIs. The server will return a definition for each valid URI in the array. |
|
QueryBuilds | Given an array of BuildDetailSpec objects, this web method will return a result list of BuildQueryResult objects the same size as the input array. If no matches are found, then the BuildQueryResult object will just have empty lists. |
|
QueryBuildsByUri | Queries builds by URI instead of by path with the provided options. A single BuildQueryResult object is returned from the query, with a BuildDetail list the same length as the input URI array. If a particular URI does not match any builds, then the corresponding index in the resulting BuildDetail list will be null. The amount of data returned from the query is controlled by means of the options parameter. |
|
QueryProcessTemplates | |
|
RequestIntermediateLogs | Requests the intermediate diagnostics logs to be available under the drop location. |
|
StopBuilds | Stops in-progress builds with the provided URIs. If a build has already been completed then it will be ignored and considered a success. The user performing this call must have the AdministerBuild permission to all team projects for which stops are being made. |
|
ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.) |
|
UpdateBuildDefinitions | Provided an array of BuildDefinition objects, this method updates the build server definitions with the given data. |
|
UpdateBuildInformation | Updates the build information according to the changes provided. All information involved in the changes is returned to the caller except for deleted nodes. |
|
UpdateBuilds | Updates build details with the provided information. The user must have the AdministerBuild permission on the team project which contains the build in order to perform this action. |
|
UpdateProcessTemplates |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.) |
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.