BuildHttpClientBase.GetPathContentsAsync 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
| GetPathContentsAsync(Guid, String, Nullable<Guid>, String, String, String, Object, CancellationToken) |
[Preview API] Gets the contents of a directory in the given source code repository. |
| GetPathContentsAsync(String, String, Nullable<Guid>, String, String, String, Object, CancellationToken) |
[Preview API] Gets the contents of a directory in the given source code repository. |
GetPathContentsAsync(Guid, String, Nullable<Guid>, String, String, String, Object, CancellationToken)
[Preview API] Gets the contents of a directory in the given source code repository.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>> GetPathContentsAsync(Guid project, string providerName, Nullable<Guid> serviceEndpointId = null, string repository = null, string commitOrBranch = null, string path = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPathContentsAsync : Guid * string * Nullable<Guid> * string * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>>
override this.GetPathContentsAsync : Guid * string * Nullable<Guid> * string * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>>Parameters
- project
- Guid
Project ID
- providerName
- String
The name of the source provider.
If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
- repository
- String
If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
- commitOrBranch
- String
The identifier of the commit or branch from which a file's contents are retrieved.
- path
- String
The path contents to list, relative to the root of the repository.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPathContentsAsync(String, String, Nullable<Guid>, String, String, String, Object, CancellationToken)
[Preview API] Gets the contents of a directory in the given source code repository.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>> GetPathContentsAsync(string project, string providerName, Nullable<Guid> serviceEndpointId = null, string repository = null, string commitOrBranch = null, string path = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPathContentsAsync : string * string * Nullable<Guid> * string * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>>
override this.GetPathContentsAsync : string * string * Nullable<Guid> * string * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.SourceRepositoryItem>>Parameters
- project
- String
Project ID or project name
- providerName
- String
The name of the source provider.
If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
- repository
- String
If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
- commitOrBranch
- String
The identifier of the commit or branch from which a file's contents are retrieved.
- path
- String
The path contents to list, relative to the root of the repository.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.