Compartir a través de

CloudAdapter class

  • Referencia
Paquete:
botbuilder

Un adaptador que implementa el protocolo Bot Framework y se puede hospedar en entornos en la nube diferentes tanto públicos como privados.

Extends

CloudAdapterBase

Constructores

CloudAdapter(BotFrameworkAuthentication)

Inicializa una nueva instancia de la clase CloudAdapter.

Propiedades heredadas

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Métodos

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

Se usa para conectar el adaptador a una canalización con nombre.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Controle una conexión de socket web aplicando una función lógica a cada solicitud de streaming.
process(Request, Response, (context: TurnContext) => Promise<void>)

Procese una solicitud web aplicando una función lógica.

Métodos heredados

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[])

Agrega middleware a la canalización del adaptador.

Detalles del constructor

CloudAdapter(BotFrameworkAuthentication)

Inicializa una nueva instancia de la clase CloudAdapter.

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Parámetros

botFrameworkAuthentication

BotFrameworkAuthentication

Instancia opcional de BotFrameworkAuthentication

Detalles de las propiedades heredadas

BotIdentityKey 

BotIdentityKey: symbol

Valor de propiedad

symbol

heredado de BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valor de propiedad

symbol

heredado de BotAdapter.ConnectorClientKey

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valor de propiedad

symbol

heredado de CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valor de propiedad

symbol

heredado de BotAdapter.OAuthScopeKey

onTurnError 

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

Valor de propiedad

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

heredado de BotAdapter.onTurnError

UserTokenClientKey 

UserTokenClientKey: symbol

Valor de propiedad

symbol

heredado de CloudAdapterBase.UserTokenClientKey

Detalles del método

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

Se usa para conectar el adaptador a una canalización con nombre.

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

Parámetros

pipeName

string

Nombre de canalización al que conectarse (nota: produce dos servidores de canalización con nombre anexando ".incoming" y ".saliente" a este nombre)

logic

(context: TurnContext) => Promise<void>

Función lógica que se va a llamar a los turnos del bot resultante.

appId

string

Identificador de aplicación del bot

audience

string

Audiencia que se va a usar para la comunicación saliente. Variará según el entorno de nube.

callerId

string

Opcional, el identificador del autor de la llamada

retryCount

number

Opcional, el número de veces que se reintenta una conexión con error (el valor predeterminado es 7)

Devoluciones

Promise<void>

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

Controle una conexión de socket web aplicando una función lógica a cada solicitud de streaming.

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

Parámetros

req
Request

Un de solicitud HTTP entrante

socket

INodeSocket

El de INodeSocket correspondiente

head

INodeBuffer

El INodeBuffer correspondiente

logic

(context: TurnContext) => Promise<void>

Función lógica que se va a aplicar

Devoluciones

Promise<void>

una promesa que representa la operación asincrónica.

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

Procese una solicitud web aplicando una función lógica.

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

Parámetros

req
Request

El de respuesta http correspondiente

res
Response
logic

(context: TurnContext) => Promise<void>

Función lógica que se va a aplicar

Devoluciones

Promise<void>

una promesa que representa la operación asincrónica.

Detalles de los métodos heredados

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

Advertencia

Esta API ya está en desuso.

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

Parámetros

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Devoluciones

Promise<void>

Heredado 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>

Devoluciones

Promise<void>

Heredado 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>

Devoluciones

Promise<void>

Heredado de CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parámetros

context

TurnContext

reference

Partial<ConversationReference>

Devoluciones

Promise<void>

Heredado de CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parámetros

context

TurnContext

activities

Partial<Activity>[]

Devoluciones

Promise<ResourceResponse[]>

Heredado de CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>) 

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

Parámetros

context

TurnContext

activity

Partial<Activity>

Devoluciones

Promise<ResourceResponse | void>

heredado de CloudAdapterBase.updateActivity

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

Agrega middleware a la canalización del adaptador.

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

Parámetros

middlewares

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

Los controladores de middleware o middleware que se van a agregar.

Devoluciones

this

Objeto de adaptador actualizado.

Comentarios

El middleware se agrega al adaptador en el momento de la inicialización. Cada turno, el adaptador llama a su middleware en el orden en que lo agregó.

Heredado de BotAdapter.use