TfvcHttpClientBase.GetItemContentAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Overloads

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(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(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, 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.

public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemContentAsync(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, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetItemContentAsync : string * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * Nullable<bool> * 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.

download

Nullable<Boolean>

If true, create a downloadable attachment.

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

Version descriptor. Default is null.

includeContent

Nullable<Boolean>

Set to true to include item content when requesting json. Default is false.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Stream>

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.

public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemContentAsync(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, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetItemContentAsync : Guid * string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * Nullable<bool> * 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.

download

Nullable<Boolean>

If true, create a downloadable attachment.

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

Version descriptor. Default is null.

includeContent

Nullable<Boolean>

Set to true to include item content when requesting json. Default is false.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Stream>

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.

public virtual System.Threading.Tasks.Task<System.IO.Stream> GetItemContentAsync(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, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetItemContentAsync : string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * Nullable<bool> * 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.

download

Nullable<Boolean>

If true, create a downloadable attachment.

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

Version descriptor. Default is null.

includeContent

Nullable<Boolean>

Set to true to include item content when requesting json. Default is false.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Stream>