IAgentClient.SendActivityStreamedAsync 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
| Name | Description |
|---|---|
| SendActivityStreamedAsync(String, IActivity, IActivity, Boolean, CancellationToken) |
Send an Activity with streaming replies. |
| SendActivityStreamedAsync<T>(String, IActivity, Action<IActivity>, IActivity, Boolean, CancellationToken) |
Send an Activity with streaming replies. |
SendActivityStreamedAsync(String, IActivity, IActivity, Boolean, CancellationToken)
Send an Activity with streaming replies.
public System.Collections.Generic.IAsyncEnumerable<object> SendActivityStreamedAsync(string agentConversationId, Microsoft.Agents.Core.Models.IActivity activity, Microsoft.Agents.Core.Models.IActivity relatesTo = default, bool useAnonymous = false, System.Threading.CancellationToken cancellationToken = default);abstract member SendActivityStreamedAsync : string * Microsoft.Agents.Core.Models.IActivity * Microsoft.Agents.Core.Models.IActivity * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<obj>Public Function SendActivityStreamedAsync (agentConversationId As String, activity As IActivity, Optional relatesTo As IActivity = Nothing, Optional useAnonymous As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Object)Parameters
- agentConversationId
- String
Agent conversation identifier.
- activity
- IActivity
Activity to send.
- relatesTo
- IActivity
What the activity relates to.
- useAnonymous
- Boolean
Specify an anonymous user.
- cancellationToken
- CancellationToken
Cancellation token.
Returns
Enumerator for the responses returned from the async streamed send operation.
Applies to
SendActivityStreamedAsync<T>(String, IActivity, Action<IActivity>, IActivity, Boolean, CancellationToken)
Send an Activity with streaming replies.
public System.Threading.Tasks.Task<Microsoft.Agents.Client.StreamResponse<T>> SendActivityStreamedAsync<T>(string agentConversationId, Microsoft.Agents.Core.Models.IActivity activity, Action<Microsoft.Agents.Core.Models.IActivity> handler, Microsoft.Agents.Core.Models.IActivity relatesTo = default, bool useAnonymous = false, System.Threading.CancellationToken cancellationToken = default);abstract member SendActivityStreamedAsync : string * Microsoft.Agents.Core.Models.IActivity * Action<Microsoft.Agents.Core.Models.IActivity> * Microsoft.Agents.Core.Models.IActivity * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Agents.Client.StreamResponse<'T>>Public Function SendActivityStreamedAsync(Of T) (agentConversationId As String, activity As IActivity, handler As Action(Of IActivity), Optional relatesTo As IActivity = Nothing, Optional useAnonymous As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StreamResponse(Of T))Type Parameters
- T
Parameters
- agentConversationId
- String
Agent conversation identifier.
- activity
- IActivity
Activity to send.
- relatesTo
- IActivity
What the activity relates to.
- useAnonymous
- Boolean
Specify an anonymous user.
- cancellationToken
- CancellationToken
Cancellation token.
Returns
A task that represents the async streamed send operation.
Remarks
This method will handle EndOfConversation Value and InvokeResponse.Body return values, specified by T.