StreamingRequestHandler Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Streaming

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.18.1

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.

A request handler that processes incoming requests sent over an IStreamingTransport and adheres to the Bot Framework Protocol v3 with Streaming Extensions.

public class StreamingRequestHandler : Microsoft.Bot.Streaming.RequestHandler, IDisposable

type StreamingRequestHandler = class
    inherit RequestHandler
    interface IDisposable

Public Class StreamingRequestHandler
Inherits RequestHandler
Implements IDisposable

Inheritance: Object

RequestHandler
StreamingRequestHandler

Implements: IDisposable

Constructors

StreamingRequestHandler(IBot, IStreamingActivityProcessor, StreamingConnection, String, ILogger)	Initializes a new instance of the StreamingRequestHandler class.
StreamingRequestHandler(IBot, IStreamingActivityProcessor, String, ILogger)	Initializes a new instance of the StreamingRequestHandler class and establishes a connection over a Named Pipe to a streaming channel.
StreamingRequestHandler(IBot, IStreamingActivityProcessor, String, String, ILogger)	Initializes a new instance of the StreamingRequestHandler class and establishes a connection over a Named Pipe to a streaming channel.
StreamingRequestHandler(IBot, IStreamingActivityProcessor, WebSocket, ILogger)	Initializes a new instance of the StreamingRequestHandler class and establishes a connection over a WebSocket to a streaming channel.
StreamingRequestHandler(IBot, IStreamingActivityProcessor, WebSocket, String, ILogger)	Initializes a new instance of the StreamingRequestHandler class and establishes a connection over a WebSocket to a streaming channel.

Properties

Audience	Gets the intended recipient of Activities sent from this StreamingRequestHandler.
ServiceUrl	Gets the URL of the channel endpoint this StreamingRequestHandler receives requests from.

Methods

ConversationAddedTime(String)	Gets the DateTime when the conversation was added to this request handler.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)	Disposes resources of the StreamingRequestHandler.
ForgetConversation(String)	Removes the given conversation from this instance of the StreamingRequestHandler's collection of tracked conversations.
HasConversation(String)	Checks to see if the set of conversations this StreamingRequestHandler has received requests for contains the passed in conversation ID.
ListenAsync()	Begins listening for incoming requests over this StreamingRequestHandler's server.
ListenAsync(CancellationToken)	Begins listening for incoming requests over this StreamingRequestHandler's server.
ProcessRequestAsync(ReceiveRequest, ILogger<RequestHandler>, Object, CancellationToken)	Handles incoming requests.
SendActivityAsync(Activity, CancellationToken)	Converts an Activity into a StreamingRequest and sends it to the channel this StreamingRequestHandler is connected to.
SendStreamingRequestAsync(StreamingRequest, CancellationToken)	Sends a StreamingRequest to the connected streaming channel.
ServerDisconnected(Object, DisconnectedEventArgs)	An event handler for server disconnected events.

Applies to