Class WorkItemTrackingHttpClient

Inheritance

System.Object

WorkItemTrackingHttpClient

Namespace: CrashCABN.BugFiler

Assembly: CrashCABN.BugFiler.AzureDevOps.dll

Syntax

public class WorkItemTrackingHttpClient : TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient

Constructors

WorkItemTrackingHttpClient(Uri, HttpMessageHandler, Boolean)

Declaration

public WorkItemTrackingHttpClient(Uri baseUrl, HttpMessageHandler pipeline, bool disposeHandler)

Parameters

Type	Name	Description
System.Uri	baseUrl
System.Net.Http.HttpMessageHandler	pipeline
System.Boolean	disposeHandler

WorkItemTrackingHttpClient(Uri, VssCredentials)

Declaration

public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials)

Parameters

Type	Name	Description
System.Uri	baseUrl
VssCredentials	credentials

WorkItemTrackingHttpClient(Uri, VssCredentials, DelegatingHandler[])

Declaration

public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, params DelegatingHandler[] handlers)

Parameters

Type	Name	Description
System.Uri	baseUrl
VssCredentials	credentials
System.Net.Http.DelegatingHandler[]	handlers

WorkItemTrackingHttpClient(Uri, VssCredentials, VssHttpRequestSettings)

Declaration

public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings)

Parameters

Type	Name	Description
System.Uri	baseUrl
VssCredentials	credentials
VssHttpRequestSettings	settings

WorkItemTrackingHttpClient(Uri, VssCredentials, VssHttpRequestSettings, DelegatingHandler[])

Declaration

public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings, params DelegatingHandler[] handlers)

Parameters

Type	Name	Description
System.Uri	baseUrl
VssCredentials	credentials
VssHttpRequestSettings	settings
System.Net.Http.DelegatingHandler[]	handlers

Methods

GetWorkItemTypeFieldsWithReferencesAsync(String, Nullable<TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel>, Object, CancellationToken)

Get a list of fields with detailed references.

Declaration

public virtual Task<List<WorkItemTypeFieldWithReferences>> GetWorkItemTypeFieldsWithReferencesAsync(string project, TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel? expand = default(TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel? ), object userState = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	project	Project ID or project name.
System.Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel>	expand	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
System.Object	userState	User state property to add to request header.
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<WorkItemTypeFieldWithReferences>>	A list of fields.

Remarks

This method does not exist in the API but is necessary to get the entire field details and types.

GetWorkItemTypeFieldsWithReferencesAsync(String, String, Nullable<TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel>, Object, CancellationToken)

Get a list of fields for a work item type with detailed references.

Declaration

public virtual Task<List<TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldWithReferences>> GetWorkItemTypeFieldsWithReferencesAsync(string project, string type, TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel? expand = default(TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel? ), object userState = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	project	Project ID or project name.
System.String	type	Work item type.
System.Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldsExpandLevel>	expand	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
System.Object	userState	User state property to add to request header.
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemTypeFieldWithReferences>>	A list of fields.

Remarks

This method is a pass-through call to the base, used for mocking in unit tests.