TestAdapter class

Cria uma nova instância de TestAdapter.

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

Parâmetros

Obtém a fila de respostas do bot.

activeQueue: Partial<Activity>[]

Valor da propriedade

Obtém ou define uma referência à conversa atual.

conversation: ConversationReference

Valor da propriedade

Obtém um valor que indica se as atividades de rastreamento devem ser enviadas. Define um valor que determina se as atividades de rastreamento devem ser enviadas.

boolean enableTrace

Valor da propriedade

Um valor que indica se as atividades de rastreamento devem ser enviadas.

Obtém ou define a localidade da conversa.

locale: string

Valor da propriedade

Obtém ou define um manipulador de erros que pode capturar exceções no middleware ou aplicativo. Define um manipulador de erros que pode capturar exceções no middleware ou aplicativo.

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

Valor da propriedade

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

Comentários

O manipulador de erros é chamado com estes parâmetros:

Activity modelo que será mesclado com todas as atividades enviadas à lógica em teste.

template: Partial<Activity>

Valor da propriedade

BotIdentityKey: symbol

Valor da propriedade

herdado de BotAdapter.BotIdentityKey

ConnectorClientKey: symbol

Valor da propriedade

herdado de BotAdapter.ConnectorClientKey

OAuthScopeKey: symbol

Valor da propriedade

herdado de BotAdapter.OAuthScopeKey

Adiciona um token trocável falso para que ele possa ser trocado posteriormente.

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

Parâmetros

Adiciona um token de usuário falso para que ele possa ser recuperado posteriormente.

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

Parâmetros

O TestAdapter não implementa continueConversation() e retornará um erro se for chamado.

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

Parâmetros

Retornos

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

Crie uma ConversationReference.

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

Parâmetros

Retornos

OConversationReference .

Executa uma operação de troca de token, como para logon único.

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

Parâmetros

Retornos

Se a promessa for concluída, o token trocado será retornado.

Desconscreve o usuário com o servidor de token.

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

Parâmetros

Retornos

Um dicionário de resourceUrl para o TokenResponse correspondente.

Desativa e retorna a próxima resposta de bot do activeQueue.

function getNextReply(): Partial<Activity>

Retornos

A próxima atividade na fila; ou indefinido, se a fila estiver vazia.

Obtém um link de entrada do servidor de token que pode ser enviado como parte de um SigninCard.

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

Parâmetros

Retornos

Um link de entrada do servidor de token que pode ser enviado como parte de um SigninCard.

Obtém um recurso de entrada.

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

Parâmetros

Retornos

Um com um novo objeto SignInUrlResponse.

Recupera de forma assíncrona o status do token para cada conexão configurada para o usuário fornecido. No testAdapter, recupera tokens que foram adicionados anteriormente por meio de addUserToken.

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

Parâmetros

Retornos

Os objetos TokenStatus recuperados.

Recupera o token OAuth para um usuário que está em um fluxo de entrada.

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

Parâmetros

Retornos

O token OAuth para um usuário que está em um fluxo de entrada.

Cria uma atividade de mensagem com base no texto e no contexto de conversa atual.

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

Parâmetros

Retornos

Uma atividade de mensagem apropriada.

Recebe uma atividade e a executa por meio do pipeline de middleware.

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

Parâmetros

Retornos

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

Envia algo para o bot. Isso retorna uma nova instância de TestFlow que pode ser usada para adicionar etapas adicionais para inspecionar a resposta dos bots e, em seguida, enviar atividades adicionais.

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

Parâmetros

Retornos

uma nova instância TestFlow que pode ser usada para adicionar etapas adicionais para inspecionar a resposta dos bots e, em seguida, enviar atividades adicionais.

Comentários

Este exemplo mostra como enviar uma mensagem e, em seguida, verificar se a resposta era conforme o esperado:

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

Processa uma atividade de mensagem de um usuário.

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

Parâmetros

Retornos

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

Desconscreve o usuário com o servidor de token.

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

Parâmetros

Retornos

Envie algo para o bot e espera que o bot retorne com uma determinada resposta.

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

Parâmetros

Retornos

Um novo objeto TestFlow que acrescenta essa troca à troca modelada.

Comentários

Isso é simplesmente um wrapper em torno de chamadas para send() e assertReply(). Esse é um padrão tão comum que um auxiliar é fornecido.

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

Teste uma lista de atividades.

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

Parâmetros

Retornos

Um novo objeto TestFlow que acrescenta essa troca à troca modelada.

Comentários

Cada atividade com a função "bot" será processada com assertReply() e todas as outras atividades serão processadas como uma mensagem de usuário com send().

Adiciona uma instrução para gerar uma exceção durante solicitações de troca.

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

Parâmetros

Retoma de forma assíncrona uma conversa com um usuário, possivelmente depois de algum tempo.

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

Parâmetros

Retornos

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

Herdado deBotAdapter.continueConversationAsync

Retoma de forma assíncrona uma conversa com um usuário, possivelmente depois de algum tempo.

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

Parâmetros

Retornos

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

Herdado deBotAdapter.continueConversationAsync

Retoma de forma assíncrona uma conversa com um usuário, possivelmente depois de algum tempo.

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

Parâmetros

Retornos

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

Herdado deBotAdapter.continueConversationAsync

Cria uma conversa no canal especificado.

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

Parâmetros

Retornos

Uma promessa que representa a operação assíncrona

Comentários

Para iniciar uma conversa, o bot deve saber suas informações de conta e as informações da conta do usuário nesse canal. A maioria dos _channels dá suporte apenas ao início de uma conversa direta (não em grupo).

O adaptador tenta criar uma nova conversa no canal e envia uma atividade conversationUpdate por meio de seu pipeline de middleware para o método lógico.

Se a conversa for estabelecida com os usuários especificados, a ID da conversão da atividade conterá a ID da nova conversa.

Herdado deBotAdapter.createConversationAsync

Adiciona middleware ao pipeline do adaptador.

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

Parâmetros

Retornos

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