CloudAdapter class

Pacote:

botbuilder

Um adaptador que implementa o Protocolo bot framework e pode ser hospedado em ambientes de nuvem diferentes, tanto públicos quanto privados.

Extends

CloudAdapterBase

Construtores

CloudAdapter(BotFrameworkAuthentication)

Inicializa uma nova instância da classe CloudAdapter.

Propriedades herdadas

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Métodos

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)	Usado para conectar o adaptador a um pipe nomeado.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)	Manipule uma conexão de soquete da Web aplicando uma função lógica a cada solicitação de streaming.
process(Request, Response, (context: TurnContext) => Promise<void>)	Processe uma solicitação da Web aplicando uma função lógica.

Métodos herdados

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)
continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)
createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)
deleteActivity(TurnContext, Partial<ConversationReference>)
sendActivities(TurnContext, Partial<Activity>[])
updateActivity(TurnContext, Partial<Activity>)
use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])	Adiciona middleware ao pipeline do adaptador.

Detalhes do construtor

CloudAdapter(BotFrameworkAuthentication)

Inicializa uma nova instância da classe CloudAdapter.

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Parâmetros

botFrameworkAuthentication

BotFrameworkAuthentication

Instância BotFrameworkAuthentication opcional

Detalhes das propriedades herdadas

BotIdentityKey

BotIdentityKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.BotIdentityKey

ConnectorClientKey

ConnectorClientKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.ConnectorClientKey

ConnectorFactoryKey

ConnectorFactoryKey: symbol

Valor da propriedade

symbol

herdado de CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey

OAuthScopeKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.OAuthScopeKey

onTurnError

onTurnError: (context: TurnContext, error: Error) => Promise<void>

Valor da propriedade

(context: TurnContext, error: Error) => Promise<void>

Herdado de BotAdapter.onTurnError

UserTokenClientKey

UserTokenClientKey: symbol

Valor da propriedade

symbol

herdado de CloudAdapterBase.UserTokenClientKey

Detalhes do método

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Usado para conectar o adaptador a um pipe nomeado.

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

Parâmetros

pipeName

string

Nome do pipe ao qual se conectar (observação: produz dois servidores de pipe nomeados acrescentando ".incoming" e ".outgoing" a esse nome)

logic

(context: TurnContext) => Promise<void>

A função lógica a ser chamada para turnos de bot resultantes.

appId

string

A ID do aplicativo bot

audience

string

O público a ser usado para comunicação de saída. O valor variará de acordo com o ambiente de nuvem.

callerId

string

Opcional, a ID do chamador

retryCount

number

Opcional, o número de vezes para tentar novamente uma conexão com falha (o padrão é 7)

Retornos

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Manipule uma conexão de soquete da Web aplicando uma função lógica a cada solicitação de streaming.

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parâmetros

req

Request

Uma solicitação HTTP de entrada

socket

INodeSocket

O INodeSocket correspondente

head

INodeBuffer

O INodeBuffer correspondente

logic

(context: TurnContext) => Promise<void>

A função lógica a ser aplicada

Retornos

Promise<void>

uma promessa que representa a operação assíncrona.

process(Request, Response, (context: TurnContext) => Promise<void>)

Processe uma solicitação da Web aplicando uma função lógica.

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parâmetros

req

Request

O de resposta http correspondente

res

Response

logic

(context: TurnContext) => Promise<void>

A função lógica a ser aplicada

Retornos

Promise<void>

uma promessa que representa a operação assíncrona.

Detalhes do método herdado

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)

Aviso

Essa API foi preterida.

function continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>

Parâmetros

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Retornos

Promise<void>

Herdado de CloudAdapterBase.continueConversation

continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)

function continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: (context: TurnContext) => Promise<void> | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>

Parâmetros

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

(context: TurnContext) => Promise<void> | string

maybeLogic

(context: TurnContext) => Promise<void>

Retornos

Promise<void>

Herdado de CloudAdapterBase.continueConversationAsync

createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)

function createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parâmetros

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Retornos

Promise<void>

Herdado de CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>)

function deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>

Parâmetros

context

TurnContext

reference

Partial<ConversationReference>

Retornos

Promise<void>

herdado de CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[])

function sendActivities(context: TurnContext, activities: Partial<Activity>[]): Promise<ResourceResponse[]>

Parâmetros

context

TurnContext

activities

Partial<Activity>[]

Retornos

Promise<ResourceResponse[]>

herdado de CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>)

function updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>

Parâmetros

context

TurnContext

activity

Partial<Activity>

Retornos

Promise<ResourceResponse | void>

herdado de CloudAdapterBase.updateActivity

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Adiciona middleware ao pipeline do adaptador.

function use(middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]): this

Parâmetros

middlewares

(context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]

Os manipuladores de middleware ou middleware a serem adicionados.

Retornos

this

O objeto do adaptador atualizado.

Comentários

O middleware é adicionado ao adaptador no momento da inicialização. A cada turno, o adaptador chama seu middleware na ordem em que você o adicionou.

Herdado de BotAdapter.use