BotAdapter Classe

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.BotAdapter

public abstract class BotAdapter

Représente un adaptateur de bot qui peut connecter un bot à un point de terminaison de service. Cette classe est abstraite.

L’adaptateur de bot encapsule les processus d’authentification et envoie des activités vers et reçoit des activités du service Bot Connector. Lorsque votre bot reçoit une activité, l’adaptateur crée un objet de contexte, le transmet à la logique d’application de votre bot et renvoie des réponses au canal de l’utilisateur.

Utilisez use(Middleware middleware) pour ajouter des objets Middleware à votre adaptateur\u2019collection d’intergiciels. L’adaptateur traite et dirige les activités entrantes via le pipeline d’intergiciel de bot vers la logique de votre bot\u2019, puis revenez à nouveau. À mesure que chaque activité circule dans et hors du bot, chaque élément d’intergiciel peut inspecter ou agir sur l’activité, avant et après l’exécution de la logique du bot.

TurnContext Activity Bot Middleware

Récapitulatif du champ

Modificateur et type Champ et description
static final java.lang.String BOT_IDENTITY_KEY

Clé pour stocker l’identité des revendications de bot.
static final java.lang.String OAUTH_CLIENT_KEY

Clé pour stocker le client oauth du bot.
static final java.lang.String OAUTH_SCOPE_KEY

Clé pour stocker l’étendue oauth du bot.

Récapitulatif du constructeur

Constructeur Description
BotAdapter()

Résumé de la méthode

Modificateur et type Méthode et description
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envoie un message proactif à une conversation.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

En cas de substitution dans une classe dérivée, supprime une activité existante dans la conversation.
protected MiddlewareSet getMiddlewareSet()

Obtient la collection d’intergiciels dans le pipeline de l’adaptateur.
OnTurnErrorHandler getOnTurnError()

Obtient le gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

Démarre le traitement de l’activité pour le tour actuel du bot.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

En cas de substitution dans une classe dérivée, envoie des activités à la conversation.
void setOnTurnError(OnTurnErrorHandler withTurnError)

Définit le gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

En cas de substitution dans une classe dérivée, remplace une activité existante dans la conversation.
BotAdapter use(Middleware middleware)

Ajoute un intergiciel au pipeline de l’adaptateur.

Méthodes héritées de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Détails du champ

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Clé pour stocker l’identité des revendications de bot.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Clé pour stocker le client oauth du bot.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Clé pour stocker l’étendue oauth du bot.

Détails du constructeur

BotAdapter

public BotAdapter()

Détails de la méthode

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Paramètres:

claimsIdentity - ClaimsIdentity pour la conversation.
continuationActivity - Activité avec la conversationReference appropriée avec laquelle poursuivre la conversation.
callback - Méthode à appeler pour le tour du bot de résultat.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Paramètres:

claimsIdentity - ClaimsIdentity pour la conversation.
continuationActivity - Activité avec la conversationReference appropriée avec laquelle poursuivre la conversation.
audience - Valeur indiquant le destinataire du message proactif.
callback - Méthode à appeler pour le tour du bot de résultat.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Paramètres:

claimsIdentity - Référence ClaimsIdentity pour la conversation.
reference - Référence à la conversation pour continuer.
callback - Méthode à appeler pour le tour du bot de résultat.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Paramètres:

claimsIdentity - Référence ClaimsIdentity pour la conversation.
reference - Référence à la conversation pour continuer.
audience - Valeur indiquant le destinataire du message proactif.
callback - Méthode à appeler pour le tour du bot de résultat.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Paramètres:

botId - ID d’application du bot. Ce paramètre est ignoré dans un seul locataire, les adaptateurs (console, test, etc.), mais il est essentiel pour BotFrameworkAdapter, qui prend en charge plusieurs locataires.
continuationActivity - Activité avec la conversationReference appropriée avec laquelle poursuivre la conversation.
callback - Méthode à appeler pour le tour du bot de résultat.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envoie un message proactif à une conversation.

Paramètres:

botAppId - ID d’application du bot. Ce paramètre est ignoré dans un seul locataire, les adaptateurs (console, test, etc.), mais il est essentiel pour BotFrameworkAdapter, qui prend en charge plusieurs locataires.
reference - Référence à la conversation pour continuer.
callback - Méthode à appeler pour le tour de bot résultant.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur. 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

En cas de substitution dans une classe dérivée, supprime une activité existante dans la conversation.

Paramètres:

context - Objet de contexte pour le tour.
reference - Référence de conversation pour l’activité à supprimer.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. La ConversationReference#getActivityId de la référence de conversation identifie l’activité à supprimer. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Obtient la collection d’intergiciels dans le pipeline de l’adaptateur.

Retours:

Collection d’intergiciels pour le pipeline.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Obtient le gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.

Retours:

Gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Démarre le traitement de l’activité pour le tour actuel du bot. L’adaptateur appelle l’intergiciel dans l’ordre dans lequel vous l’avez ajouté. L’adaptateur passe dans l’objet de contexte pour le tour et un délégué suivant, et l’intergiciel appelle le délégué pour passer le contrôle au middleware suivant dans le pipeline. Une fois le contrôle atteint la fin du pipeline, l’adaptateur appelle la méthode callback. Si un composant middleware n’appelle pas le délégué suivant, l’adaptateur n’appelle pas l’un des intergiciels suivants\u2019méthodes onTurn(TurnContext turnContext, NextDelegate next) ou la méthode de rappel, ainsi que les courts-circuits du pipeline.

Lorsque le tour est lancé par une activité utilisateur (messagerie réactive), la méthode de rappel est une référence à la méthode onTurn(TurnContext turnContext) du bot. Lorsque le tour est lancé par un appel à continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (messagerie proactive), la méthode de rappel est la méthode de rappel fournie dans l’appel.

Paramètres:

context - Objet de contexte du tour.
callback - Méthode de rappel à exécuter à la fin du pipeline.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

En cas de substitution dans une classe dérivée, envoie des activités à la conversation.

Paramètres:

context - Objet de contexte pour le tour.
activities - Activités à envoyer.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si les activités sont correctement envoyées, le résultat de la tâche contient un tableau d’objets ResourceResponse contenant les ID que le canal de réception affecté aux activités. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Définit le gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.

Paramètres:

withTurnError - Gestionnaire d’erreurs qui peut intercepter les exceptions dans l’intergiciel ou l’application.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

En cas de substitution dans une classe dérivée, remplace une activité existante dans la conversation.

Paramètres:

context - Objet de contexte pour le tour.
activity - Nouvelle activité de remplacement.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si l’activité est correctement envoyée, le résultat de la tâche contient un objet ResourceResponse contenant l’ID que le canal de réception affecté à l’activité.

Avant de l’appeler, définissez l’ID de l’activité de remplacement sur l’ID de l’activité à remplacer. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Ajoute un intergiciel au pipeline de l’adaptateur.

Paramètres:

middleware - Intergiciel à ajouter.

Retours:

Objet adaptateur mis à jour. L’intergiciel est ajouté à l’adaptateur au moment de l’initialisation. Pour chaque tour, l’adaptateur appelle l’intergiciel dans l’ordre dans lequel vous l’avez ajouté.

S’applique à