Share via


IActivityTaskQueue.QueueBackgroundActivity Method

Definition

Enqueue an Activity, with Claims, to be processed on a background thread. before enqueueing.

public bool QueueBackgroundActivity(System.Security.Claims.ClaimsIdentity claimsIdentity, Microsoft.Agents.Builder.IChannelAdapter adapter, Microsoft.Agents.Core.Models.IActivity activity, bool proactive = false, string proactiveAudience = default, Type agentType = default, Func<Microsoft.Agents.Core.Models.InvokeResponse,System.Threading.Tasks.Task> onComplete = default, Microsoft.AspNetCore.Http.IHeaderDictionary headers = default);
abstract member QueueBackgroundActivity : System.Security.Claims.ClaimsIdentity * Microsoft.Agents.Builder.IChannelAdapter * Microsoft.Agents.Core.Models.IActivity * bool * string * Type * Func<Microsoft.Agents.Core.Models.InvokeResponse, System.Threading.Tasks.Task> * Microsoft.AspNetCore.Http.IHeaderDictionary -> bool
Public Function QueueBackgroundActivity (claimsIdentity As ClaimsIdentity, adapter As IChannelAdapter, activity As IActivity, Optional proactive As Boolean = false, Optional proactiveAudience As String = Nothing, Optional agentType As Type = Nothing, Optional onComplete As Func(Of InvokeResponse, Task) = Nothing, Optional headers As IHeaderDictionary = Nothing) As Boolean

Parameters

claimsIdentity
ClaimsIdentity

Authenticated ClaimsIdentity used to process the activity.

adapter
IChannelAdapter
activity
IActivity

Activity to be processed.

proactive
Boolean
proactiveAudience
String
agentType
Type
onComplete
Func<InvokeResponse,Task>
headers
IHeaderDictionary

Headers used for the current Activity request.

Returns

true if the item was queued. false would indicate the queue has been disabled (probably shutting down).

Remarks

It is assumed these Claims have been authenticated via JwtTokenValidation.AuthenticateRequest.

Applies to