Edit

Share via


GitHttpClientBase.GetItemContentAsync Method

Definition

Overloads

GetItemContentAsync(String, String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
String

Project ID or project name

repositoryId
String

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(String, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, Guid repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
String

Project ID or project name

repositoryId
Guid

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(Guid, String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
Guid

Project ID

repositoryId
String

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(Guid, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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, Guid repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
Guid

Project ID

repositoryId
Guid

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(String, String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
String

Project ID or project name

repositoryId
String

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to

GetItemContentAsync(String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

repositoryId
String

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(Guid, String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
Guid

Project ID

repositoryId
String

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to

GetItemContentAsync(Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, 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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

repositoryId
Guid

The name or ID of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

Version descriptor. Default is null.

includeContent
Nullable<Boolean>

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

resolveLfs
Nullable<Boolean>

Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetItemContentAsync(Guid, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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, Guid repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
Guid

Project ID

repositoryId
Guid

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to

GetItemContentAsync(String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

repositoryId
String

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to

GetItemContentAsync(Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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 repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

repositoryId
Guid

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to

GetItemContentAsync(String, Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Nullable<Boolean>, Object, CancellationToken)

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, Guid repositoryId, string path, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, Nullable<bool> includeContent = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetItemContentAsync : string * Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

Parameters

project
String

Project ID or project name

repositoryId
Guid

The Id of the repository.

path
String

The item path.

scopePath
String

The path scope. The default is null.

recursionLevel
Nullable<VersionControlRecursionType>

The recursion level of this request. The default is 'none', no recursion.

includeContentMetadata
Nullable<Boolean>

Set to true to include content metadata. Default is false.

latestProcessedChange
Nullable<Boolean>

Set to true to include the lastest changes. Default is false.

download
Nullable<Boolean>

Set to true to download the response as a file. Default is false.

versionDescriptor
GitVersionDescriptor

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

Applies to