Edit

Share via


TfvcHttpClientBase Class

Definition

[Microsoft.VisualStudio.Services.WebApi.ResourceArea("8AA40520-446D-40E6-89F6-9C9F9CE44C48")]
public abstract class TfvcHttpClientBase : Microsoft.TeamFoundation.SourceControl.WebApi.TfvcCompatHttpClientBase
type TfvcHttpClientBase = class
    inherit TfvcCompatHttpClientBase
Public MustInherit Class TfvcHttpClientBase
Inherits TfvcCompatHttpClientBase
Inheritance
Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase
TfvcHttpClientBase
Derived
Attributes
Microsoft.VisualStudio.Services.WebApi.ResourceAreaAttribute

Constructors

TfvcHttpClientBase(Uri, HttpMessageHandler, Boolean)
TfvcHttpClientBase(Uri, VssCredentials, DelegatingHandler[])
TfvcHttpClientBase(Uri, VssCredentials, VssHttpRequestSettings, DelegatingHandler[])
TfvcHttpClientBase(Uri, VssCredentials, VssHttpRequestSettings)
TfvcHttpClientBase(Uri, VssCredentials)

Methods

CreateChangesetAsync(TfvcChangeset, Guid, Object, CancellationToken)

[Preview API] Create a new changeset.

CreateChangesetAsync(TfvcChangeset, Object, CancellationToken)

[Preview API] Create a new changeset.

CreateChangesetAsync(TfvcChangeset, String, Object, CancellationToken)

[Preview API] Create a new changeset.

GetBatchedChangesetsAsync(TfvcChangesetsRequestData, Object, CancellationToken)

[Preview API] Returns changesets for a given list of changeset Ids.

GetBranchAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

GetBranchAsync(String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

GetBranchAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

GetBranchesAsync(Guid, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

GetBranchesAsync(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

GetBranchesAsync(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

GetBranchRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get branch hierarchies below the specified scopePath

GetBranchRefsAsync(String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get branch hierarchies below the specified scopePath

GetBranchRefsAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get branch hierarchies below the specified scopePath

GetChangesetAsync(Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

GetChangesetAsync(Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

GetChangesetAsync(String, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

GetChangesetChangesAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve Tfvc changes for a given changeset.

GetChangesetsAsync(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve Tfvc Changesets

GetChangesetsAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve Tfvc Changesets

GetChangesetsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve Tfvc Changesets

GetChangesetWorkItemsAsync(Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieves the work items associated with a particular changeset.

GetItemAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemContentAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemContentAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemContentAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemContentAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemContentAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemContentAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemsAsync(Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, TfvcVersionDescriptor, Object, CancellationToken)

[Preview API] Get a list of Tfvc items

GetItemsAsync(String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, TfvcVersionDescriptor, Object, CancellationToken)

[Preview API] Get a list of Tfvc items

GetItemsAsync(String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, TfvcVersionDescriptor, Object, CancellationToken)

[Preview API] Get a list of Tfvc items

GetItemsBatchAsync(TfvcItemRequestData, Guid, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemsBatchAsync(TfvcItemRequestData, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemsBatchAsync(TfvcItemRequestData, String, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemsBatchZipAsync(TfvcItemRequestData, Guid, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemsBatchZipAsync(TfvcItemRequestData, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemsBatchZipAsync(TfvcItemRequestData, String, Object, CancellationToken)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

GetItemTextAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemTextAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemTextAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemTextAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemTextAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemTextAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemZipAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemZipAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemZipAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemZipAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetItemZipAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

GetItemZipAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Obsolete.

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

(Inherited from TfvcCompatHttpClientBase)
GetLabelAsync(Guid, String, TfvcLabelRequestData, Object, CancellationToken)

[Preview API] Get a single deep label.

GetLabelAsync(String, String, TfvcLabelRequestData, Object, CancellationToken)

[Preview API] Get a single deep label.

GetLabelAsync(String, TfvcLabelRequestData, Object, CancellationToken)

[Preview API] Get a single deep label.

GetLabelItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get items under a label.

GetLabelsAsync(Guid, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

GetLabelsAsync(String, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

GetLabelsAsync(TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

GetShelvesetAsync(String, TfvcShelvesetRequestData, Object, CancellationToken)

[Preview API] Get a single deep shelveset.

GetShelvesetChangesAsync(String, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get changes included in a shelveset.

GetShelvesetsAsync(TfvcShelvesetRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Return a collection of shallow shelveset references.

GetShelvesetWorkItemsAsync(String, Object, CancellationToken)

[Preview API] Get work items associated with a shelveset.

GetTfvcStatisticsAsync(Guid, String, Object, CancellationToken)

[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC.

GetTfvcStatisticsAsync(String, Object, CancellationToken)

[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC.

GetTfvcStatisticsAsync(String, String, Object, CancellationToken)

[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC.

Applies to