GitHttpClientBase.GetRefsAsync 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
GetRefsAsync(Guid, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid project, string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : Guid * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string project, string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : string * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, Guid, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string project, Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : string * Guid * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(Guid, Guid, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid project, Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : Guid * Guid * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : Guid * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Object, CancellationToken)
[Preview API] Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> includeStatuses = null, Nullable<bool> includeMyBranches = null, Nullable<bool> latestStatusesOnly = null, Nullable<bool> peelTags = null, string filterContains = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetRefsAsync : string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs (starts with).
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.
[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
[optional] Annotated tags will populate the PeeledObjectId property. default is false.
- filterContains
- String
[optional] A filter to apply to the refs (contains).
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string project, Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : string * Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : string * Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(Guid, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid project, string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : Guid * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : Guid * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(Guid, Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid project, Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : Guid * Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : Guid * Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(Guid repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : Guid * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- repositoryId
- Guid
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetRefsAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
Queries the provided repository for its refs and returns them.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>> GetRefsAsync(string project, string repositoryId, string filter = null, Nullable<bool> includeLinks = null, Nullable<bool> latestStatusesOnly = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetRefsAsync : string * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>
override this.GetRefsAsync : string * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitRef>>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The name or ID of the repository.
- filter
- String
[optional] A filter to apply to the refs.
[optional] Specifies if referenceLinks should be included in the result. default is false.
[optional] True to include only the tip commit status for each ref. This option requires includeStatuses to be true. The default value is false.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.