IChannelApiHandler.OnUpdateActivityAsync Method

Definition

OnUpdateActivityAsync() API.

public System.Threading.Tasks.Task<Microsoft.Agents.Core.Models.ResourceResponse> OnUpdateActivityAsync(System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, string activityId, Microsoft.Agents.Core.Models.IActivity activity, System.Threading.CancellationToken cancellationToken = default);
abstract member OnUpdateActivityAsync : System.Security.Claims.ClaimsIdentity * string * string * Microsoft.Agents.Core.Models.IActivity * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Agents.Core.Models.ResourceResponse>
Public Function OnUpdateActivityAsync (claimsIdentity As ClaimsIdentity, conversationId As String, activityId As String, activity As IActivity, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse)

Parameters

claimsIdentity
ClaimsIdentity

claimsIdentity for the Agent, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.

conversationId
String

Conversation ID.

activityId
String

activityId to update.

activity
IActivity

replacement Activity.

cancellationToken
CancellationToken

The cancellation token.

Returns

task for a resource response.

Remarks

Some channels allow you to edit an existing activity to reflect the new state of a Agent conversation.

For example, you can remove buttons after someone has clicked "Approve" button.

Applies to