botframework-streaming package

PayloadAssembler

汇编流式处理库的有效负载。

ContentStream

包含要解码的内容的固定或无限长度的流。

CancelDisassembler

流式处理取消反汇编程序。

HttpContentStreamDisassembler

Http 内容流的反汇编程序

PayloadDisassembler

基类流式处理有效负载反汇编。

RequestDisassembler

流式处理请求反汇编程序。

ResponseDisassembler

流式处理响应反汇编程序。

HttpContent

包含 SubscribableStream 的 HttpContent 类。

HttpContentStream

StreamingRequest 的流集合中包含的附件,该集合本身包含任何形式的媒体项。

NamedPipeClient

使用命名管道进行进程间通信的流式传输客户端实现。

NamedPipeServer

使用命名管道进行进程间通信的流式传输服务器实现。

NamedPipeTransport

基于命名管道的传输发送方和接收方抽象

PayloadReceiver

用于流式处理的有效负载接收器。

PayloadSender

流式处理有效负载发送方。

TransportDisconnectedEvent

触发断开连接事件时要包含的事件。

HeaderSerializer

流式处理标头序列化程序

PayloadAssemblerManager

协调有效负载的程序集。

RequestManager

协调和管理挂起的流式处理请求。

SendOperations

流式处理有效负载的发送操作。

StreamManager

协调和管理流。

ProtocolAdapter

为流式处理创建协议适配器。

RequestHandler

由用于处理通过 IStreamingTransport 发送的传入流式处理请求的类实现。

StreamingRequest

使用流式处理扩展传输通过 Bot Framework 协议 3 发送的基本请求类型,等效于 HTTP 请求消息。

StreamingResponse

通过 Bot Framework 协议 3 发送的基本响应类型,具有流式处理扩展传输,等效于 HTTP 响应消息。

SubscribableStream

Duplex 扩展,与 一起操作, PayloadAssembler 将原始字节转换为易耗型。

NodeWebSocketFactory

表示用于创建 WebSocket 服务器的 NodeWebSocketFactory。

NodeWebSocketFactoryBase

表示用于创建 WebSocket 的抽象 NodeWebSocketFactoryBase 类。

NodeWebSocket

ISocket 的实现,用于与 NodeWebSocketFactory 一起使用来创建 WebSocket 服务器。

WebSocketClient

要用作流式传输的基于 Web 套接字的客户端。

WebSocketServer

要用作流式传输的基于 Web 套接字的服务器。

WebSocketTransport

基于 Web 套接字的传输。

接口

IAssemblerParams

流式汇编程序的参数。

IBrowserFileReader

部分表示 W3C 文件API 工作草稿中的 FileReader。 有关详细信息,请参阅 https://w3c.github.io/FileAPI/#APIASynch。 此接口支持框架,不应直接为代码调用此接口。

IBrowserWebSocket

部分表示 HTML Living Standard 中的 WebSocket。 有关详细信息,请参阅 https://html.spec.whatwg.org/multipage/web-sockets.html。 此接口支持框架,不应直接为代码调用此接口。

IEventEmitter

表示 Node.js 中模块中的 EventEmitter net 。 此接口支持框架,不应直接为代码调用此接口。

IHeader

流式处理有效负载标头定义。

IHttpContentHeaders

流式处理 Http 内容标头定义。

INodeBuffer

表示 Node.js 中模块的缓冲区 net 。 此接口支持框架,不应直接为代码调用此接口。

INodeIncomingMessage

表示来自 Node.js 模块的 IncomingMessage http 。 此接口支持框架,不应直接为代码调用此接口。

INodeServer

表示 Node.js 模块中的服务器 net 。 此接口支持框架,不应直接为代码调用此接口。

AddressInfo
INodeSocket

表示 Node.js 中模块中的套接字 net 。 此接口支持框架,不应直接为代码调用此接口。

WritableStream
IReceiveRequest

流式处理接收请求定义。

IReceiveResponse

来自接收请求的流式处理响应。

IRequestPayload

流式处理请求有效负载的定义。

IResponsePayload

所有对话框的基类。

ISendPacket

流式发送数据包定义。

ISocket
IStreamDescription

流说明的定义。

IStreamWrapper

具有长度的流。

IStreamingTransportClient

用于定义流式传输客户端特征的抽象。 示例可能的实现包括 WebSocket 传输客户端或 NamedPipe 传输客户端。

IStreamingTransportServer

用于定义流式传输服务器特征的抽象。 可能的示例实现包括 WebSocket 传输服务器或 NamedPipe 传输服务器。

ITransport

泛型传输定义的抽象。

ITransportReceiver

可接收请求的流式传输的定义。

ITransportSender

可发送请求的流式传输的定义。

类型别名

BufferEncoding
ValidBuffer

版权所有 (c) Microsoft Corporation。 保留所有权利。 根据 MIT 许可证获得许可。

TransportDisconnectedEventHandler
ConnectionListener

枚举

PayloadConstants

流式处理有效负载的常量。

PayloadTypes

流式处理库中支持的有效负载的类型。

函数

createNodeServer(ConnectionListener)

创建节点“net”服务器

getServerFactory()

获取用于创建节点“net”服务器实例的函数

generateGuid()

生成 uuid v4 字符串。

函数详细信息

createNodeServer(ConnectionListener)

创建节点“net”服务器

function createNodeServer(callback?: ConnectionListener): INodeServer

参数

callback
ConnectionListener

可选连接侦听器

返回

节点“net”服务器实例

getServerFactory()

获取用于创建节点“net”服务器实例的函数

function getServerFactory(): (callback?: ConnectionListener) => INodeServer

返回

(callback?: ConnectionListener) => INodeServer

服务器工厂函数

generateGuid()

生成 uuid v4 字符串。

function generateGuid(): string

返回

string

uuidv4 字符串。