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

Implémente

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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 constructeur

Constructeur Description
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crée un objet de contexte.

Résumé de la méthode

Modificateur et type Méthode et description
void close()

Closable#close.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

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

Supprime une activité existante.
void finalize()

Appel automatique de #close.
Activity getActivity()

Obtient l’activité associée à ce tour ; ou null lors du traitement d’un message proactif.
BotAdapter getAdapter()

Obtient l’adaptateur de bot qui a créé cet objet de contexte.
java.util.List<Activity> getBufferedReplyActivities()

Obtient une liste d’activités à envoyer quand « context ». activité.Mode de remise== 'attendezréponses'.
java.lang.String getLocale()

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

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

Obtient les services inscrits sur cet objet de contexte.
TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

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

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

Envoie un ensemble d’activités à l’expéditeur de l’activité entrante.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activityToSend)

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

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

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

Envoie une activité de message à l’expéditeur de l’activité entrante.
void setLocale(String withLocale)

Définissez les paramètres régionaux sur cet objet de contexte.
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Remplace une activité existante.

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 constructeur

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crée un objet de contexte.

Paramètres:

withAdapter - Adaptateur créant le contexte.
withActivity - Activité entrante pour le tour ; ou null pour un tour pour un message proactif.

Détails de la méthode

close

public void close()

AutoClosable#close.

Exception:

java.lang.Exception - Si TurnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Supprime une activité existante. La ConversationReference#getActivityId de la référence de conversation indique l’activité dans la conversation à supprimer.

Paramètres:

conversationReference - Conversation contenant l’activité à supprimer.

Retours:

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

deleteActivity

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

finalize

public void finalize()

Appel automatique de #close.

Remplacements:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Obtient l’activité associée à ce tour ; ou null lors du traitement d’un message proactif.

getAdapter

public BotAdapter getAdapter()

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

Retours:

BotAdaptor pour ce tour.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Obtient une liste d’activités à envoyer quand « context ». Activity.DeliveryMode == 'expectReplies'.

Retours:

Liste des activités.

getLocale

public 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 boolean getResponded()

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

getTurnState

public TurnContextStateCollection getTurnState()

Obtient les services inscrits sur cet objet de contexte.

Retours:

TurnContextStateCollection pour ce tour.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Paramètres:

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

Retours:

Objet de contexte mis à jour.

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

Paramètres:

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

Retours:

Objet de contexte mis à jour.

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Paramètres:

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

Retours:

Objet de contexte mis à jour.

sendActivities

public CompletableFuture sendActivities(List activities)

Envoie un ensemble d’activités à l’expéditeur de l’activité entrante.

Paramètres:

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.

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

Paramètres:

activityToSend - Activité à envoyer.

Retours:

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

sendActivity

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

Paramètres:

textReplyToSend - Texte du message à envoyer.
speak - Pour contrôler différentes caractéristiques de la voix de votre bot, telles que la fréquence vocale, le volume, la prononciation et la hauteur, spécifiez le format SSML (Speech Synthesis Markup Language).

Retours:

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

sendActivity

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

Paramètres:

textReplyToSend - Texte du message à envoyer.
speak - Pour contrôler différentes caractéristiques de la voix de votre bot, telles que la fréquence vocale, le volume, la prononciation et la hauteur, spécifiez le format SSML (Speech Synthesis Markup Language).
inputHint - (Facultatif) Indicateur d’entrée.

Retours:

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

setLocale

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

Remplace une activité existante.

Paramètres:

withActivity - Nouvelle activité de remplacement.

Retours:

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

S’applique à