TfvcHttpClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[Microsoft.VisualStudio.Services.WebApi.ClientCircuitBreakerSettings(22, 80)]
[Microsoft.VisualStudio.Services.WebApi.ResourceArea("8AA40520-446D-40E6-89F6-9C9F9CE44C48")]
public class TfvcHttpClient : Microsoft.TeamFoundation.SourceControl.WebApi.TfvcHttpClientBasetype TfvcHttpClient = class
inherit TfvcHttpClientBasePublic Class TfvcHttpClient
Inherits TfvcHttpClientBase- Inheritance
-
Microsoft.VisualStudio.Services.WebApi.VssHttpClientBaseTfvcHttpClient
- Attributes
-
Microsoft.VisualStudio.Services.WebApi.ClientCircuitBreakerSettingsAttribute Microsoft.VisualStudio.Services.WebApi.ResourceAreaAttribute
Constructors
Methods
| AddModelAsQueryParams(IList<KeyValuePair<String,String>>, String, Object) | |
| CreateChangesetAsync(TfvcChangeset, Guid, Object, CancellationToken) |
[Preview API] Create a new changeset. (Inherited from TfvcHttpClientBase) |
| CreateChangesetAsync(TfvcChangeset, Object, CancellationToken) |
[Preview API] Create a new changeset. (Inherited from TfvcHttpClientBase) |
| CreateChangesetAsync(TfvcChangeset, String, Object, CancellationToken) |
[Preview API] Create a new changeset. (Inherited from TfvcHttpClientBase) |
| GetBatchedChangesetsAsync(TfvcChangesetsRequestData, Object, CancellationToken) |
[Preview API] Returns changesets for a given list of changeset Ids. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| GetBranchRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Get branch hierarchies below the specified scopePath (Inherited from TfvcHttpClientBase) |
| GetBranchRefsAsync(String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Get branch hierarchies below the specified scopePath (Inherited from TfvcHttpClientBase) |
| GetBranchRefsAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Get branch hierarchies below the specified scopePath (Inherited from TfvcHttpClientBase) |
| 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 (Inherited from TfvcHttpClientBase) |
| 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 (Inherited from TfvcHttpClientBase) |
| 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 (Inherited from TfvcHttpClientBase) |
| GetChangesetChangesAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Retrieve Tfvc changes for a given changeset. (Inherited from TfvcHttpClientBase) |
| GetChangesetChangesPagedAsync(Int32, Int32, String, Object, CancellationToken) |
[Internal customers only API] Get changeset changes information with continuation token support. Gets the specified number of changes for a particular changeset. |
| GetChangesetsAsync(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken) |
[Preview API] Retrieve Tfvc Changesets (Inherited from TfvcHttpClientBase) |
| GetChangesetsAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken) |
[Preview API] Retrieve Tfvc Changesets (Inherited from TfvcHttpClientBase) |
| GetChangesetsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken) |
[Preview API] Retrieve Tfvc Changesets (Inherited from TfvcHttpClientBase) |
| GetChangesetWorkItemsAsync(Nullable<Int32>, Object, CancellationToken) |
[Preview API] Retrieves the work items associated with a particular changeset. (Inherited from TfvcHttpClientBase) |
| GetContinuationToken(HttpResponseMessage) | |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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 (Inherited from TfvcHttpClientBase) |
| GetItemsAsync(String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, TfvcVersionDescriptor, Object, CancellationToken) |
[Preview API] Get a list of Tfvc items (Inherited from TfvcHttpClientBase) |
| GetItemsAsync(String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, TfvcVersionDescriptor, Object, CancellationToken) |
[Preview API] Get a list of Tfvc items (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| GetItemsByChangesetPagedAsync(Guid, Int32, Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| GetItemsByChangesetPagedAsync(Int32, Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| GetItemsByChangesetPagedAsync(String, Int32, Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| GetItemsPagedAsync(Guid, Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| GetItemsPagedAsync(Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| GetItemsPagedAsync(String, Int32, String, Nullable<Int32>, String, Object, CancellationToken) |
[Internal customers only API] Get lightweight item metadata information with continuation token support. Gets the specified number of items under the scopePath at full recursion. |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| 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. (Inherited from TfvcHttpClientBase) |
| GetLabelAsync(String, String, TfvcLabelRequestData, Object, CancellationToken) |
[Preview API] Get a single deep label. (Inherited from TfvcHttpClientBase) |
| GetLabelAsync(String, TfvcLabelRequestData, Object, CancellationToken) |
[Preview API] Get a single deep label. (Inherited from TfvcHttpClientBase) |
| GetLabelItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Get items under a label. (Inherited from TfvcHttpClientBase) |
| GetLabelsAsync(Guid, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Get a collection of shallow label references. (Inherited from TfvcHttpClientBase) |
| GetLabelsAsync(String, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Get a collection of shallow label references. (Inherited from TfvcHttpClientBase) |
| GetLabelsAsync(TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Get a collection of shallow label references. (Inherited from TfvcHttpClientBase) |
| GetPagedList<T>(HttpResponseMessage, CancellationToken) | |
| GetShelvesetAsync(String, TfvcShelvesetRequestData, Object, CancellationToken) |
[Preview API] Get a single deep shelveset. (Inherited from TfvcHttpClientBase) |
| GetShelvesetChangesAsync(String, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Get changes included in a shelveset. (Inherited from TfvcHttpClientBase) |
| GetShelvesetsAsync(TfvcShelvesetRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken) |
[Preview API] Return a collection of shallow shelveset references. (Inherited from TfvcHttpClientBase) |
| GetShelvesetWorkItemsAsync(String, Object, CancellationToken) |
[Preview API] Get work items associated with a shelveset. (Inherited from TfvcHttpClientBase) |
| GetTfvcStatisticsAsync(Guid, String, Object, CancellationToken) |
[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC. (Inherited from TfvcHttpClientBase) |
| GetTfvcStatisticsAsync(String, Object, CancellationToken) |
[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC. (Inherited from TfvcHttpClientBase) |
| GetTfvcStatisticsAsync(String, String, Object, CancellationToken) |
[Preview API] Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC. (Inherited from TfvcHttpClientBase) |
| SendAsync<T>(HttpMethod, Guid, Object, ApiResourceVersion, HttpContent, IEnumerable<KeyValuePair<String,String>>, Object, CancellationToken, Func<HttpResponseMessage,CancellationToken,Task<T>>) | |
| SendAsync<T>(HttpMethod, IEnumerable<KeyValuePair<String,String>>, Guid, Object, ApiResourceVersion, HttpContent, IEnumerable<KeyValuePair<String, String>>, Object, CancellationToken, Func<HttpResponseMessage, CancellationToken,Task<T>>) | |
| SendAsync<T>(HttpRequestMessage, Object, CancellationToken, Func<HttpResponseMessage,CancellationToken,Task<T>>) | |