GitHttpClientBase.GetItemsAsync 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
| GetItemsAsync(Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
| GetItemsAsync(String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
| GetItemsAsync(Guid, Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
| GetItemsAsync(Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
| GetItemsAsync(String, Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
| GetItemsAsync(String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken) |
[Preview API] Get Item Metadata and/or Content for a collection of items. 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. |
GetItemsAsync(Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(Guid repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- repositoryId
- Guid
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetItemsAsync(String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(string repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- repositoryId
- String
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetItemsAsync(Guid, Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(Guid project, Guid repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : Guid * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : Guid * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetItemsAsync(Guid, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(Guid project, string repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : Guid * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- project
- Guid
Project ID
- repositoryId
- String
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetItemsAsync(String, Guid, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(string project, Guid repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : string * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : string * Guid * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetItemsAsync(String, String, String, Nullable<VersionControlRecursionType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, GitVersionDescriptor, Object, CancellationToken)
[Preview API] Get Item Metadata and/or Content for a collection of items. 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.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>> GetItemsAsync(string project, string repositoryId, string scopePath = null, Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> recursionLevel = null, Nullable<bool> includeContentMetadata = null, Nullable<bool> latestProcessedChange = null, Nullable<bool> download = null, Nullable<bool> includeLinks = null, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor versionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetItemsAsync : string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
override this.GetItemsAsync : string * string * string * Nullable<Microsoft.TeamFoundation.SourceControl.WebApi.VersionControlRecursionType> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitItem>>
Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The name or ID of the repository.
- scopePath
- String
The path scope. The default is null.
- recursionLevel
- Nullable<VersionControlRecursionType>
The recursion level of this request. The default is 'none', no recursion.
Set to true to include the lastest changes. Default is false.
- versionDescriptor
- GitVersionDescriptor
Version descriptor. Default is null.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.