TestAdapter class

Crea una nueva instancia de TestAdapter.

new TestAdapter(logicOrConversation?: (context: TurnContext) => Promise<void> | ConversationReference, template?: Partial<Activity>, sendTraceActivity?: boolean)

Parámetros

Obtiene la cola de respuestas del bot.

activeQueue: Partial<Activity>[]

Valor de propiedad

Obtiene o establece una referencia a la conversación actual.

conversation: ConversationReference

Valor de propiedad

Obtiene un valor que indica si se van a enviar actividades de seguimiento. Establece un valor que indica si se van a enviar actividades de seguimiento.

boolean enableTrace

Valor de propiedad

Valor que indica si se van a enviar actividades de seguimiento.

Obtiene o establece la configuración regional de la conversación.

locale: string

Valor de propiedad

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

Promesa que representa la operación asincrónica.

Comentarios

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

Activity plantilla que se combinará con todas las actividades enviadas a la lógica en prueba.

template: Partial<Activity>

Valor de propiedad

BotIdentityKey: symbol

Valor de propiedad

heredado debotAdapter.BotIdentityKey

ConnectorClientKey: symbol

Valor de propiedad

heredado de BotAdapter.ConnectorClientKey

OAuthScopeKey: symbol

Valor de propiedad

heredado debotAdapter.OAuthScopeKey

Agrega un token intercambiable falso para que se pueda intercambiar más adelante.

function addExchangeableToken(connectionName: string, channelId: string, userId: string, exchangeableItem: string, token: string)

Parámetros

Agrega un token de usuario falso para que se pueda recuperar más adelante.

function addUserToken(connectionName: string, channelId: string, userId: string, token: string, magicCode?: string)

Parámetros

El TestAdapter no implementa continueConversation() y devolverá un error si se llama.

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

Parámetros

Devoluciones

Promesa que representa la operación asincrónica.

Cree una conversationReference.

static function createConversation(name: string, user?: string, bot?: string): ConversationReference

Parámetros

Devoluciones

El ConversationReference.

Realiza una operación de intercambio de tokens como para el inicio de sesión único.

function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parámetros

Devoluciones

Si se completa la promesa, se devuelve el token intercambiado.

Cierra la sesión del usuario con el servidor de tokens.

function getAadTokens(_context: TurnContext, _connectionName: string, _resourceUrls: string[]): Promise<[key: string]: TokenResponse>

Parámetros

Devoluciones

Diccionario de resourceUrl al tokenResponse correspondiente.

Desqueues y devuelve la siguiente respuesta del bot de activeQueue.

function getNextReply(): Partial<Activity>

Devoluciones

La siguiente actividad de la cola; o undefined, si la cola está vacía.

Obtiene un vínculo de inicio de sesión del servidor de tokens que se puede enviar como parte de un SigninCard.

function getSignInLink(context: TurnContext, connectionName: string): Promise<string>

Parámetros

Devoluciones

Vínculo de inicio de sesión desde el servidor de tokens que se puede enviar como parte de signinCard.

Obtiene un recurso de inicio de sesión.

function getSignInResource(context: TurnContext, connectionName: string, userId?: string, _finalRedirect?: string): Promise<SignInUrlResponse>

Parámetros

Devoluciones

Un Promise con un nuevo objeto signInUrlResponse .

Recupera de forma asincrónica el estado del token para cada conexión configurada para el usuario especificado. En testAdapter, recupera los tokens que se agregaron anteriormente a través de addUserToken.

function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, _oAuthAppCredentials?: any): Promise<any[]>

Parámetros

Devoluciones

Los objetos TokenStatus recuperados.

Recupera el token de OAuth para un usuario que está en un flujo de inicio de sesión.

function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>

Parámetros

Devoluciones

Token de OAuth para un usuario que está en un flujo de inicio de sesión.

Crea una actividad de mensaje a partir del texto y el contexto conversacional actual.

function makeActivity(text?: string): Partial<Activity>

Parámetros

Devoluciones

Una actividad de mensaje adecuada.

Recibe una actividad y la ejecuta a través de la canalización de middleware.

function processActivity(activity: string | Partial<Activity>, callback?: (context: TurnContext) => Promise<any>): Promise<any>

Parámetros

Devoluciones

Promesa que representa la operación asincrónica.

Envía algo al bot. Esto devuelve una nueva instancia de TestFlow que se puede usar para agregar pasos adicionales para inspeccionar la respuesta de los bots y, a continuación, enviar actividades adicionales.

function send(userSays: string | Partial<Activity>): TestFlow

Parámetros

Devoluciones

una nueva instancia TestFlow que se puede usar para agregar pasos adicionales para inspeccionar la respuesta de los bots y, a continuación, enviar actividades adicionales.

Comentarios

En este ejemplo se muestra cómo enviar un mensaje y, a continuación, comprobar que la respuesta era la esperada:

adapter.send('hi')
       .assertReply('Hello World')
       .then(() => done());

Procesa una actividad de mensaje de un usuario.

function sendTextToBot(userSays: string, callback: (context: TurnContext) => Promise<any>): Promise<any>

Parámetros

Devoluciones

Promesa que representa la operación asincrónica.

Cierra la sesión del usuario con el servidor de tokens.

function signOutUser(context: TurnContext, connectionName?: string, userId?: string): Promise<void>

Parámetros

Devoluciones

Envíe algo al bot y espera que el bot vuelva con una respuesta determinada.

function test(userSays: string | Partial<Activity>, expected: string | Partial<Activity> | (activity: Partial<Activity>, description?: string) => void, description?: string, _timeout?: number): TestFlow

Parámetros

Devoluciones

Nuevo TestFlow objeto que anexa este intercambio al intercambio modelado.

Comentarios

Esto es simplemente un contenedor en torno a las llamadas a send() y assertReply(). Este es un patrón tan común que se proporciona un asistente.

adapter.test('hi', 'Hello World')
       .then(() => done());

Pruebe una lista de actividades.

function testActivities(activities: Partial<Activity>[], description?: string, timeout?: number): TestFlow

Parámetros

Devoluciones

Nuevo TestFlow objeto que anexa este intercambio al intercambio modelado.

Comentarios

Cada actividad con el rol "bot" se procesará con assertReply() y todas las demás actividades se procesarán como un mensaje de usuario con send().

Agrega una instrucción para iniciar una excepción durante las solicitudes de intercambio.

function throwOnExchangeRequest(connectionName: string, channelId: string, userId: string, exchangeableItem: string)

Parámetros

Reanuda de forma asincrónica una conversación con un usuario, posiblemente después de algún tiempo.

function continueConversationAsync(claimsIdentity: ClaimsIdentity, reference: Partial<ConversationReference>, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parámetros

Devoluciones

una promesa que representa la operación asincrónica

heredado deBotAdapter.continueConversationAsync

Reanuda de forma asincrónica una conversación con un usuario, posiblemente después de algún tiempo.

function continueConversationAsync(claimsIdentity: ClaimsIdentity, reference: Partial<ConversationReference>, audience: string, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parámetros

Devoluciones

una promesa que representa la operación asincrónica

heredado deBotAdapter.continueConversationAsync

Reanuda de forma asincrónica una conversación con un usuario, posiblemente después de algún tiempo.

function continueConversationAsync(botAppId: string, reference: Partial<ConversationReference>, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parámetros

Devoluciones

una promesa que representa la operación asincrónica

heredado deBotAdapter.continueConversationAsync

Crea una conversación en el canal especificado.

function createConversationAsync(_botAppId: string, _channelId: string, _serviceUrl: string, _audience: string, _conversationParameters: ConversationParameters, _logic: (context: TurnContext) => Promise<void>): Promise<void>

Parámetros

Devoluciones

Promesa que representa la operación asincrónica

Comentarios

Para iniciar una conversación, el bot debe conocer su información de cuenta y la información de la cuenta del usuario en ese canal. La mayoría de _channels solo admiten iniciar una conversación de mensaje directo (no grupo).

El adaptador intenta crear una nueva conversación en el canal y, a continuación, envía una actividad de conversationUpdate a través de su canalización de middleware al método lógico.

Si la conversación se establece con los usuarios especificados, el identificador de la convergencia de la actividad contendrá el identificador de la nueva conversación.

heredado deBotAdapter.createConversationAsync

Agrega middleware a la canalización del adaptador.

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

Parámetros

Devoluciones

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