GitHttpClientBase.GetPushCommitsAsync 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
GetPushCommitsAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.
GetPushCommitsAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.
GetPushCommitsAsync(Guid, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.
GetPushCommitsAsync(Guid, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.
GetPushCommitsAsync(String, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.
GetPushCommitsAsync(String, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieve a list of commits associated with a particular push.

GetPushCommitsAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(Guid repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

repositoryId: Guid

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

GetPushCommitsAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(string repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

repositoryId: String

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

GetPushCommitsAsync(Guid, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(Guid project, Guid repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : Guid * Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : Guid * Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

project: Guid

Project ID

repositoryId: Guid

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

GetPushCommitsAsync(Guid, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(Guid project, string repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : Guid * string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : Guid * string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

project: Guid

Project ID

repositoryId: String

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

GetPushCommitsAsync(String, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(string project, Guid repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : string * Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : string * Guid * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

project: String

Project ID or project name

repositoryId: Guid

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

GetPushCommitsAsync(String, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieve a list of commits associated with a particular push.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>> GetPushCommitsAsync(string project, string repositoryId, int pushId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushCommitsAsync : string * string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>
override this.GetPushCommitsAsync : string * string * int * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitCommitRef>>

Parameters

project: String

Project ID or project name

repositoryId: String

The id or friendly name of the repository. To use the friendly name, projectId must also be specified.

pushId: Int32

The id of the push.

top: Nullable<Int32>

The maximum number of commits to return ("get the top x commits").

skip: Nullable<Int32>

The number of commits to skip.

includeLinks: Nullable<Boolean>

Set to false to avoid including REST Url links for resources. Defaults to true.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitCommitRef>>

Applies to

Feedback

Was this page helpful?