TestAdapter class

Crée une instance TestAdapter.

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

Paramètres

Obtient la file d’attente des réponses du bot.

activeQueue: Partial<Activity>[]

Valeur de propriété

Obtient ou définit une référence à la conversation actuelle.

conversation: ConversationReference

Valeur de propriété

Obtient une valeur indiquant s’il faut envoyer des activités de trace. Définit une valeur inidicatant s’il faut envoyer des activités de suivi.

boolean enableTrace

Valeur de propriété

Valeur indiquant s’il faut envoyer des activités de suivi.

Obtient ou définit les paramètres régionaux de la conversation.

locale: string

Valeur de propriété

Obtient ou définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application. Définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application.

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

Valeur de propriété

Promesse représentant l’opération asynchrone.

Remarques

Le gestionnaire d’erreurs est appelé avec ces paramètres :

Activity modèle qui sera fusionné avec toutes les activités envoyées à la logique testée.

template: Partial<Activity>

Valeur de propriété

BotIdentityKey: symbol

Valeur de propriété

héritée deBotAdapter.BotIdentityKey

ConnectorClientKey: symbol

Valeur de propriété

héritée deBotAdapter.ConnectorClientKey

OAuthScopeKey: symbol

Valeur de propriété

héritée deBotAdapter.OAuthScopeKey

Ajoute un jeton échangeable factice afin qu’il puisse être échangé ultérieurement.

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

Paramètres

Ajoute un jeton d’utilisateur factice afin qu’il puisse être récupéré ultérieurement.

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

Paramètres

Le TestAdapter n’implémente pas continueConversation() et retourne une erreur si elle est appelée.

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

Paramètres

Retours

Promesse représentant l’opération asynchrone.

Créez une conversationReference.

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

Paramètres

Retours

ConversationReference.

Effectue une opération d’échange de jetons telle que pour l’authentification unique.

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

Paramètres

Retours

Si la promesse est terminée, le jeton échangé est retourné.

Déconnecte l’utilisateur avec le serveur de jetons.

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

Paramètres

Retours

Dictionnaire de resourceUrl correspondant à TokenResponse.

Dequeues et retourne la réponse du bot suivant à partir de l’activeQueue.

function getNextReply(): Partial<Activity>

Retours

Activité suivante dans la file d’attente ; ou non défini, si la file d’attente est vide.

Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.

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

Paramètres

Retours

Lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.

Obtient une ressource de connexion.

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

Paramètres

Retours

Un Promise avec un nouvel objet SignInUrlResponse.

Récupère de façon asynchrone l’état du jeton pour chaque connexion configurée pour l’utilisateur donné. Dans testAdapter, récupère les jetons qui ont été précédemment ajoutés via addUserToken.

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

Paramètres

Retours

Les objets TokenStatus récupérés.

Récupère le jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion.

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

Paramètres

Retours

Jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion.

Crée une activité de message à partir du texte et du contexte conversationnel actuel.

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

Paramètres

Retours

Activité de message appropriée.

Reçoit une activité et l’exécute via le pipeline d’intergiciel.

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

Paramètres

Retours

Promesse représentant l’opération asynchrone.

Envoie quelque chose au bot. Cette opération retourne une nouvelle instance TestFlow qui peut être utilisée pour ajouter des étapes supplémentaires pour inspecter les bots répondre, puis envoyer des activités supplémentaires.

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

Paramètres

Retours

une nouvelle instance TestFlow qui peut être utilisée pour ajouter des étapes supplémentaires pour inspecter les bots répondre, puis envoyer des activités supplémentaires.

Remarques

Cet exemple montre comment envoyer un message, puis vérifier que la réponse était comme prévu :

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

Traite une activité de message d’un utilisateur.

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

Paramètres

Retours

Promesse représentant l’opération asynchrone.

Déconnecte l’utilisateur avec le serveur de jetons.

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

Paramètres

Retours

Envoyez quelque chose au bot et attendez que le bot retourne avec une réponse donnée.

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

Paramètres

Retours

Nouvel objet TestFlow qui ajoute cet échange à l’échange modélisé.

Remarques

Il s’agit simplement d’un wrapper autour des appels à send() et assertReply(). Il s’agit d’un modèle si courant qu’un assistance est fourni.

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

Testez une liste d’activités.

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

Paramètres

Retours

Nouvel objet TestFlow qui ajoute cet échange à l’échange modélisé.

Remarques

Chaque activité avec le rôle « bot » sera traitée avec assertReply() et toutes les autres activités seront traitées en tant que message utilisateur avec send().

Ajoute une instruction pour lever une exception pendant les demandes d’échange.

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

Paramètres

Reprend de façon asynchrone une conversation avec un utilisateur, éventuellement après un certain temps.

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

Paramètres

Retours

une promesse représentant l’opération asynchrone

héritée deBotAdapter.continueConversationAsync

Reprend de façon asynchrone une conversation avec un utilisateur, éventuellement après un certain temps.

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

Paramètres

Retours

une promesse représentant l’opération asynchrone

héritée deBotAdapter.continueConversationAsync

Reprend de façon asynchrone une conversation avec un utilisateur, éventuellement après un certain temps.

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

Paramètres

Retours

une promesse représentant l’opération asynchrone

héritée deBotAdapter.continueConversationAsync

Crée une conversation sur le canal spécifié.

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

Paramètres

Retours

Promesse qui représente l’opération asynchrone

Remarques

Pour démarrer une conversation, votre bot doit connaître ses informations de compte et les informations de compte de l’utilisateur sur ce canal. La plupart des _channels prennent uniquement en charge le lancement d’une conversation de message direct (non-groupe).

L’adaptateur tente de créer une conversation sur le canal, puis envoie une activité conversationUpdate via son pipeline d’intergiciels à la méthode logique.

Si la conversation est établie avec les utilisateurs spécifiés, l’ID de la converstion de l’activité contient l’ID de la nouvelle conversation.

héritée deBotAdapter.createConversationAsync

Ajoute un intergiciel au pipeline de l’adaptateur.

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

Paramètres

Retours

Objet adaptateur mis à jour.

Remarques

L’intergiciel est ajouté à l’adaptateur au moment de l’initialisation. Chaque tour, l’adaptateur appelle son intergiciel dans l’ordre dans lequel vous l’avez ajouté.

héritée deBotAdapter.use