Class WorkItemTrackingHttpClient

Inheritance
object
VssHttpClientBase
WorkItemTrackingHttpClientCompatBase
WorkItemTrackingHttpClientBase
WorkItemTrackingHttpClient
WorkItemTrackingHttpClient
Implements
IVssHttpClient
Inherited Members
VssHttpClientBase.UserStatePropertyName
VssHttpClientBase.NegotiateRequestVersion(ApiResourceLocation, ApiResourceVersion)
VssHttpClientBase.SetResourceLocations(ApiResourceLocationCollection)
VssHttpClientBase.IsDisposed()
VssHttpClientBase.Dispose()
VssHttpClientBase.BaseAddress
VssHttpClientBase.LastResponseContext
VssHttpClientBase.Client
VssHttpClientBase.Formatter
VssHttpClientBase.ExcludeUrlsHeader
VssHttpClientBase.LightweightHeader
Namespace: CrashCABN.BugFiler
Assembly: CrashCABN.BugFiler.AzureDevOps.dll
Syntax
public class WorkItemTrackingHttpClient : WorkItemTrackingHttpClient, IVssHttpClient, IDisposable

Constructors

View Source

WorkItemTrackingHttpClient(Uri, VssCredentials)

Declaration
public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials)
Parameters
Type Name Description
Uri baseUrl
VssCredentials credentials
View Source

WorkItemTrackingHttpClient(Uri, VssCredentials, VssHttpRequestSettings)

Declaration
public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings)
Parameters
Type Name Description
Uri baseUrl
VssCredentials credentials
VssHttpRequestSettings settings
View Source

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

Declaration
public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, VssHttpRequestSettings settings, params DelegatingHandler[] handlers)
Parameters
Type Name Description
Uri baseUrl
VssCredentials credentials
VssHttpRequestSettings settings
DelegatingHandler[] handlers
View Source

WorkItemTrackingHttpClient(Uri, VssCredentials, params DelegatingHandler[])

Declaration
public WorkItemTrackingHttpClient(Uri baseUrl, VssCredentials credentials, params DelegatingHandler[] handlers)
Parameters
Type Name Description
Uri baseUrl
VssCredentials credentials
DelegatingHandler[] handlers
View Source

WorkItemTrackingHttpClient(Uri, HttpMessageHandler, bool)

Declaration
public WorkItemTrackingHttpClient(Uri baseUrl, HttpMessageHandler pipeline, bool disposeHandler)
Parameters
Type Name Description
Uri baseUrl
HttpMessageHandler pipeline
bool disposeHandler

Methods

View Source

GetWorkItemTypeFieldsWithReferencesAsync(string, WorkItemTypeFieldsExpandLevel?, object?, CancellationToken)

Get a list of fields with detailed references.

Declaration
public virtual Task<List<WorkItemTypeFieldWithReferences>> GetWorkItemTypeFieldsWithReferencesAsync(string project, WorkItemTypeFieldsExpandLevel? expand = null, object? userState = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string project

Project ID or project name.
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.
object userState

User state property to add to request header.
CancellationToken cancellationToken

The cancellation token to cancel operation.
Returns
Type Description
Task<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.

View Source

GetWorkItemTypeFieldsWithReferencesAsync(string, string, WorkItemTypeFieldsExpandLevel?, object?, CancellationToken)

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

Declaration
public virtual Task<List<WorkItemTypeFieldWithReferences>> GetWorkItemTypeFieldsWithReferencesAsync(string project, string type, WorkItemTypeFieldsExpandLevel? expand = null, object? userState = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string project

Project ID or project name.
string type

Work item type.
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.
object userState

User state property to add to request header.
CancellationToken cancellationToken

The cancellation token to cancel operation.
Returns
Type Description
Task<List<WorkItemTypeFieldWithReferences>>

A list of fields.
Remarks

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

Implements

Microsoft.VisualStudio.Services.WebApi.IVssHttpClient