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

Name	Description
GetBlobAsync(Guid, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.
GetBlobAsync(String, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.
GetBlobAsync(Guid, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.
GetBlobAsync(Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.
GetBlobAsync(String, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.
GetBlobAsync(String, String, String, Nullable<Boolean>, String, Object, CancellationToken)	Obsolete. [Preview API] Get a single blob.

GetBlobAsync(Guid, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

repositoryId: Guid

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

GetBlobAsync(String, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

repositoryId: String

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

GetBlobAsync(Guid, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(Guid project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : Guid * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : Guid * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

project: Guid

Project ID

repositoryId: Guid

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

GetBlobAsync(Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(Guid project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

project: Guid

Project ID

repositoryId: String

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

GetBlobAsync(String, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(string project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : string * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : string * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

project: String

Project ID or project name

repositoryId: Guid

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

GetBlobAsync(String, String, String, Nullable<Boolean>, String, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a single blob.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef> GetBlobAsync(string project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBlobAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>
override this.GetBlobAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitBlobRef>

Parameters

project: String

Project ID or project name

repositoryId: String

The name or ID of the repository.

sha1: String

SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.

download: Nullable<Boolean>

If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip

fileName: String

Provide a fileName to use for a download.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitBlobRef>

Attributes: ObsoleteAttribute

Applies to

Feedback

Was this page helpful?