TfvcCompatHttpClientBase.GetItemZipAsync Method
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.
Overloads
| 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. |
| 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. |
| 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. |
GetItemZipAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Caution
This API is now deprecated.
[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.
[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemZipAsync(Guid project, string path, string fileName = null, Nullable<bool> download = null, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetItemZipAsync : Guid * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetItemZipAsync : Guid * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- path
- String
Version control path of an individual item to return.
- fileName
- String
file name of item returned.
- scopePath
- String
Version control path of a folder to return multiple items.
- recursionLevel
- Nullable<VersionControlRecursionType>
None (just the item), or OneLevel (contents of a folder).
- versionDescriptor
- TfvcVersionDescriptor
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
- Attributes
Applies to
GetItemZipAsync(String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Caution
This API is now deprecated.
[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.
[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemZipAsync(string path, string fileName = null, Nullable<bool> download = null, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetItemZipAsync : string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetItemZipAsync : string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- path
- String
Version control path of an individual item to return.
- fileName
- String
file name of item returned.
- scopePath
- String
Version control path of a folder to return multiple items.
- recursionLevel
- Nullable<VersionControlRecursionType>
None (just the item), or OneLevel (contents of a folder).
- versionDescriptor
- TfvcVersionDescriptor
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
- Attributes
Applies to
GetItemZipAsync(String, String, String, Nullable<Boolean>, String, Nullable<VersionControlRecursionType>, TfvcVersionDescriptor, Object, CancellationToken)
Caution
This API is now deprecated.
[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.
[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemZipAsync(string project, string path, string fileName = null, Nullable<bool> download = null, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetItemZipAsync : string * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetItemZipAsync : string * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- path
- String
Version control path of an individual item to return.
- fileName
- String
file name of item returned.
- scopePath
- String
Version control path of a folder to return multiple items.
- recursionLevel
- Nullable<VersionControlRecursionType>
None (just the item), or OneLevel (contents of a folder).
- versionDescriptor
- TfvcVersionDescriptor
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
- Attributes