GitHttpClientBase.GetTreeAsync 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
| GetTreeAsync(Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
| GetTreeAsync(String, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
| GetTreeAsync(Guid, Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
| GetTreeAsync(Guid, String, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
| GetTreeAsync(String, Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
| GetTreeAsync(String, String, String, String, Nullable<Boolean>, String, Object, CancellationToken) |
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository. |
GetTreeAsync(Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(Guid repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- repositoryId
- Guid
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTreeAsync(String, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(string repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- repositoryId
- String
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTreeAsync(Guid, Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(Guid project, Guid repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : Guid * Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : Guid * Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTreeAsync(Guid, String, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(Guid project, string repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : Guid * string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : Guid * string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- project
- Guid
Project ID
- repositoryId
- String
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTreeAsync(String, Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(string project, Guid repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : string * Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : string * Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTreeAsync(String, String, String, String, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef> GetTreeAsync(string project, string repositoryId, string sha1, string projectId = null, Nullable<bool> recursive = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTreeAsync : string * string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>
override this.GetTreeAsync : string * string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitTreeRef>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
Repository Id.
- sha1
- String
SHA1 hash of the tree object.
- projectId
- String
Project Id.
Search recursively. Include trees underneath this tree. Default is false.
- fileName
- String
Name to use if a .zip file is returned. Default is the object ID.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.