GitHttpClientBase.UpdatePullRequestPropertiesAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Overloads

UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, Guid, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, String, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, Guid, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.
UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, String, Int32, Object, CancellationToken)	[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, Guid repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

repositoryId

Guid

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, string repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

repositoryId

String

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, Guid, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, Guid project, Guid repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

project

Guid

Project ID

repositoryId

Guid

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

UpdatePullRequestPropertiesAsync(JsonPatchDocument, Guid, String, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, Guid project, string repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * Guid * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

project

Guid

Project ID

repositoryId

String

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, Guid, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, string project, Guid repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * Guid * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

project

String

Project ID or project name

repositoryId

Guid

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

UpdatePullRequestPropertiesAsync(JsonPatchDocument, String, String, Int32, Object, CancellationToken)

[Preview API] Create or update pull request external properties. The patch operation can be add, replace or remove. For add operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For replace operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For remove operation, the path cannot be empty. If the path does not exist, no action will be performed.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection> UpdatePullRequestPropertiesAsync(Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument patchDocument, string project, string repositoryId, int pullRequestId, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>
override this.UpdatePullRequestPropertiesAsync : Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument * string * string * int * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>

Parameters

patchDocument

Microsoft.VisualStudio.Services.WebApi.Patch.Json.JsonPatchDocument

Properties to add, replace or remove in JSON Patch format.

project

String

Project ID or project name

repositoryId

String

The repository ID of the pull request’s target branch.

pullRequestId

Int32

ID of the pull request.

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<Microsoft.VisualStudio.Services.WebApi.PropertiesCollection>