AzureQueueStorage.QueueActivityAsync Method

Definition

Namespace:

Microsoft.Bot.Builder.Azure.Queues

Assembly:

Microsoft.Bot.Builder.Azure.Queues.dll

Package:

Microsoft.Bot.Builder.Azure.Queues v4.18.1-preview

Queue an Activity to an Azure.Storage.Queues.QueueClient. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size.

public override System.Threading.Tasks.Task<string> QueueActivityAsync (Microsoft.Bot.Schema.Activity activity, TimeSpan? visibilityTimeout = default, TimeSpan? timeToLive = default, System.Threading.CancellationToken cancellationToken = default);

override this.QueueActivityAsync : Microsoft.Bot.Schema.Activity * Nullable<TimeSpan> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overrides Function QueueActivityAsync (activity As Activity, Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional timeToLive As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

activity

Activity

This is expected to be an Activity retrieved from a call to activity.GetConversationReference().GetContinuationActivity(). This enables restarting the conversation using BotAdapter.ContinueConversationAsync.

visibilityTimeout

Nullable<TimeSpan>

Default value of 0. Cannot be larger than 7 days.

timeToLive

Nullable<TimeSpan>

Specifies the time-to-live interval for the message.

cancellationToken

CancellationToken

Cancellation token for the async operation.

Returns

Task<String>

SendReceipt as a Json string, from the QueueClient SendMessageAsync operation.