CloudAdapterBase class

  • Referencia
Paquete:
botbuilder-core

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

Extends
BotAdapter

Constructores

CloudAdapterBase(BotFrameworkAuthentication)

Cree una nueva instancia de CloudAdapterBase.

Propiedades

ConnectorFactoryKey
onTurnError

Obtiene o establece un controlador de errores que puede detectar excepciones en el middleware o la aplicación. Establece un controlador de errores que puede detectar excepciones en el middleware o la aplicación.
UserTokenClientKey

Propiedades heredadas

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

Métodos

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

Métodos heredados

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

Agrega middleware a la canalización del adaptador.

Detalles del constructor

CloudAdapterBase(BotFrameworkAuthentication)

Cree una nueva instancia de CloudAdapterBase.

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

Parámetros

botFrameworkAuthentication

BotFrameworkAuthentication

Un BotFrameworkAuthentication que se usa para validar y crear tokens.

Detalles de las propiedades

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valor de propiedad

symbol

onTurnError

Obtiene o establece un controlador de errores que puede detectar excepciones en el middleware o la aplicación. Establece un controlador de errores que puede detectar excepciones en el middleware o la aplicación.

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

Valor de propiedad

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

Promesa que representa la operación asincrónica.

Comentarios

Se llama al controlador de errores con estos parámetros:

Nombre Tipo Descripción
context TurnContext Objeto de contexto del turno.
error Error Error de Node.js producido.

UserTokenClientKey 

UserTokenClientKey: symbol

Valor de propiedad

symbol

Detalles de las propiedades heredadas

BotIdentityKey 

BotIdentityKey: symbol

Valor de propiedad

symbol

heredado debotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valor de propiedad

symbol

heredado de BotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valor de propiedad

symbol

heredado debotAdapter.OAuthScopeKey

Detalles del método

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>

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>

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>

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parámetros

context
TurnContext
reference

Partial<ConversationReference>

Devoluciones

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parámetros

context
TurnContext
activities

Partial<Activity>[]

Devoluciones

Promise<ResourceResponse[]>

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>

Detalles de los métodos heredados

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 deBotAdapter.use