TurnContext Interface

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

public interface TurnContext

Fournit un contexte pour un tour d’un bot.

Le contexte fournit des informations nécessaires pour traiter une activité entrante. L’objet de contexte est créé par un BotAdapter et conserve la longueur du tour.

Bot Middleware

Récapitulatif du champ

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

Résumé de la méthode

Modificateur et type Méthode et description
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

Supprime une activité existante.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

Supprime une activité existante.
abstract Activity getActivity()

Obtient l’activité pour ce tour du bot.
abstract BotAdapter getAdapter()

Obtient l’adaptateur de bot qui a créé cet objet de contexte.
abstract java.lang.String getLocale()

Obtient les paramètres régionaux sur cet objet de contexte.
abstract boolean getResponded()

Obtient une valeur indiquant si au moins une réponse a été envoyée pour le tour actuel.
abstract TurnContextStateCollection getTurnState()

Obtient la collection de valeurs mises en cache avec l’objet de contexte pour la durée de vie du tour.
abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Ajoute un gestionnaire de réponses pour les opérations de suppression d’activité.
abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Ajoute un gestionnaire de réponses pour les opérations d’envoi d’activité.
abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Ajoute un gestionnaire de réponses pour les opérations d’activité de mise à jour.
default java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(Activity[] activities)

Méthode d’assistance pour envoyer un tableau d’activités.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

Envoie une liste d’activités à l’expéditeur de l’activité entrante.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activity)

Envoie une activité à l’expéditeur de l’activité entrante.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

Envoie une activité de message à l’expéditeur de l’activité entrante.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

Envoie une activité de message à l’expéditeur de l’activité entrante.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Envoie une activité de message à l’expéditeur de l’activité entrante.
default java.util.concurrent.CompletableFuture<java.lang.Void> sendActivityBlind(Activity activity)

Envoie une activité à l’expéditeur de l’activité entrante sans retourner une ressourceréponse.
abstract void setLocale(String withLocale)

Définissez les paramètres régionaux sur cet objet de contexte.
static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Envoie une activité de trace au BotAdapter à des fins de journalisation.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Remplace une activité existante.

Détails du champ

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Détails de la méthode

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Supprime une activité existante.

Paramètres:

conversationReference - Conversation contenant 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 indique l’activité dans la conversation à supprimer.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

Supprime une activité existante.

Paramètres:

activityId - ID de l’activité à supprimer.

Retours:

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

getActivity

public abstract Activity getActivity()

Obtient l’activité pour ce tour du bot.

Retours:

Activité de ce tour du bot.

getAdapter

public abstract BotAdapter getAdapter()

Obtient l’adaptateur de bot qui a créé cet objet de contexte.

Retours:

Adaptateur de bot qui a créé cet objet de contexte.

getLocale

public abstract String getLocale()

Obtient les paramètres régionaux sur cet objet de contexte.

Retours:

Chaîne de paramètres régionaux sur cet objet de contexte.

getResponded

public abstract boolean getResponded()

Obtient une valeur indiquant si au moins une réponse a été envoyée pour le tour actuel.

Retours:

true si au moins une réponse a été envoyée pour le tour actuel ; sinon, false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Obtient la collection de valeurs mises en cache avec l’objet de contexte pour la durée de vie du tour.

Retours:

Collection de services inscrits sur cet objet de contexte.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Ajoute un gestionnaire de réponses pour les opérations de suppression d’activité.

Lorsque le deleteActivity(String activityId) du contexte est appelé, l’adaptateur appelle les gestionnaires inscrits dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte.

Paramètres:

handler - Gestionnaire à ajouter à l’objet de contexte.

Retours:

Objet de contexte mis à jour.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Ajoute un gestionnaire de réponses pour les opérations d’envoi d’activité.

Lorsque les méthodes sendActivity(Activity activity) ou sendActivities(List<Activity> activities) du contexte sont appelées, l’adaptateur appelle les gestionnaires inscrits dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte.

Paramètres:

handler - Gestionnaire à ajouter à l’objet de contexte.

Retours:

Objet de contexte mis à jour.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Ajoute un gestionnaire de réponses pour les opérations d’activité de mise à jour.

Lorsque le updateActivity(Activity withActivity) du contexte est appelé, l’adaptateur appelle les gestionnaires inscrits dans l’ordre dans lequel ils ont été ajoutés à l’objet de contexte.

Paramètres:

handler - Gestionnaire à ajouter à l’objet de contexte.

Retours:

Objet de contexte mis à jour.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Méthode d’assistance pour envoyer un tableau d’activités. Cela appelle sendActivities(List<Activity> activities).

Paramètres:

activities - Tableau d’activités.

Retours:

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

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Envoie une liste d’activités à l’expéditeur de l’activité entrante.

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.

Paramètres:

activities - Activités à envoyer.

Retours:

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

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Envoie une activité à l’expéditeur de l’activité entrante.

Paramètres:

activity - Activité à envoyer.

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é.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Envoie une activité de message à l’expéditeur de l’activité entrante.

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é.

Consultez la documentation du canal pour connaître les limites imposées au contenu de textReplyToSend.

Paramètres:

textReplyToSend - Texte du message à envoyer.

Retours:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Envoie une activité de message à l’expéditeur de l’activité entrante.

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é.

Consultez la documentation du canal pour connaître les limites imposées au contenu de textReplyToSend.

Pour contrôler différentes caractéristiques de la voix, de la vitesse, du volume, de la prononciation et du pitch de votre bot, spécifiez speak au format SSML (Speech Synthesis Markup Language).

Paramètres:

textReplyToSend - Texte du message à envoyer.
speak - Facultatif, texte à prononcer par votre bot sur un canal avec reconnaissance vocale.

Retours:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Envoie une activité de message à l’expéditeur de l’activité entrante.

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é.

Consultez la documentation du canal pour connaître les limites imposées au contenu de textReplyToSend.

Pour contrôler différentes caractéristiques de la voix, de la vitesse, du volume, de la prononciation et du pitch de votre bot, spécifiez speak au format SSML (Speech Synthesis Markup Language).

Paramètres:

textReplyToSend - Texte du message à envoyer.
speak - Facultatif, texte à prononcer par votre bot sur un canal avec reconnaissance vocale.
inputHint - Facultatif, indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client. L’un des éléments suivants : « acceptInput », « ignoringInput » ou « expectingInput ». La valeur par défaut est « acceptInput ».

Retours:

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

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Envoie une activité à l’expéditeur de l’activité entrante sans renvoyer un ResourceResponse.

Paramètres:

activity - Activité à envoyer.

Retours:

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

setLocale

public abstract void setLocale(String withLocale)

Définissez les paramètres régionaux sur cet objet de contexte.

Paramètres:

withLocale - Chaîne de paramètres régionaux sur cet objet de contexte.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Paramètres:

turnContext - TurnContext.
name - Nom de l’activité.

Retours:

Un avenir avec ResourceReponse.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Envoie une activité de trace au BotAdapter à des fins de journalisation.

Paramètres:

turnContext - Contexte du tour actuel.
name - Valeur à affecter à la propriété Activity#getName de l’activité.
value - Valeur à affecter à la propriété Activity#getValue de l’activité.
valueType - Valeur à affecter à la propriété Activity#getValueType de l’activité.
label - Valeur à affecter à la propriété Activity#getLabel de l’activité.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si l’adaptateur est hébergé dans l’émulateur, le résultat de la tâche contient un objet ResourceResponse avec l’ID de l’activité de trace d’origine ; sinon, il contient un objet ResourceResponse contenant l’ID que le canal de réception affecté à l’activité.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Remplace une activité existante.

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.

Paramètres:

withActivity - Nouvelle activité de remplacement.

Retours:

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

S’applique à