TfvcCompatHttpClientBase.GetItemAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:: Microsoft.TeamFoundation.SourceControl.WebApi.dll

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

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

GetItemAsync(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<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem> GetItemAsync(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 GetItemAsync : string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>
override this.GetItemAsync : string * string * Nullable<bool> * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>

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

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcItem>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem> GetItemAsync(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 GetItemAsync : 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<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>
override this.GetItemAsync : 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<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>

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

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcItem>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem> GetItemAsync(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 GetItemAsync : 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<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>
override this.GetItemAsync : 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<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcItem>

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

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcItem>

Attributes: ObsoleteAttribute

Applies to

Feedback

Was this page helpful?

Share via

TfvcCompatHttpClientBase.GetItemAsync Method

Definition

Overloads

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

Feedback