IChannelApiHandler.OnSendToConversationAsync 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.
SendToConversation() API.
public System.Threading.Tasks.Task<Microsoft.Agents.Core.Models.ResourceResponse> OnSendToConversationAsync(System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, Microsoft.Agents.Core.Models.IActivity activity, System.Threading.CancellationToken cancellationToken = default);
abstract member OnSendToConversationAsync : System.Security.Claims.ClaimsIdentity * string * Microsoft.Agents.Core.Models.IActivity * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Agents.Core.Models.ResourceResponse>
Public Function OnSendToConversationAsync (claimsIdentity As ClaimsIdentity, conversationId 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
conversationId.
- activity
- IActivity
Activity to send.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
task for a resource response.
Remarks
This method allows you to send an activity to the end of a conversation.
This is slightly different from ReplyToActivity(). * SendToConversation(conversationId) - will append the activity to the end of the conversation according to the timestamp or semantics of the channel. * ReplyToActivity(conversationId,ActivityId) - adds the activity as a reply to another activity, if the channel supports it. If the channel does not support nested replies, ReplyToActivity falls back to SendToConversation.
Use ReplyToActivity when replying to a specific activity in the conversation.