TurnContextImpl Klasse

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TurnContextImpl

Implementiert

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

Stellt Kontext für eine Drehung eines Bots bereit. Der Kontext stellt Informationen bereit, die zum Verarbeiten einer eingehenden Aktivität erforderlich sind. Das Kontextobjekt wird von einem BotAdapter erstellt und für die Länge der Drehung beibehalten. Bot Middleware

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Erstellt ein Kontextobjekt.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
void close()

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

Löscht eine vorhandene Aktivität.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

Löscht eine vorhandene Aktivität.
void finalize()

Automatischer Aufruf von #close.
Activity getActivity()

Ruft die Aktivität ab, die dieser Turn zugeordnet ist; oder null beim Verarbeiten einer proaktiven Nachricht.
BotAdapter getAdapter()

Ruft den Botadapter ab, der dieses Kontextobjekt erstellt hat.
java.util.List<Activity> getBufferedReplyActivities()

Ruft eine Liste der Aktivitäten ab, die gesendet werden sollen, wenn "Kontext" ist.Aktivität.Zustellungsmodus== "ErwartenAntworten".
java.lang.String getLocale()

Ruft das Gebietsschema für dieses Kontextobjekt ab.
boolean getResponded()

Gibt an, ob mindestens eine Antwort für die aktuelle Drehung gesendet wurde.
TurnContextStateCollection getTurnState()

Ruft die für dieses Kontextobjekt registrierten Dienste ab.
TurnContext onDeleteActivity(DeleteActivityHandler handler)

Fügt einen Antworthandler für Löschaktivitätsvorgänge hinzu.
TurnContext onSendActivities(SendActivitiesHandler handler)

Fügt einen Antworthandler für Sendeaktivitätsvorgänge hinzu.
TurnContext onUpdateActivity(UpdateActivityHandler handler)

Fügt einen Antworthandler für Aktualisierungsaktivitätsvorgänge hinzu.
java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

Sendet eine Reihe von Aktivitäten an den Absender der eingehenden Aktivität.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activityToSend)

Sendet eine Aktivität an den Absender der eingehenden Aktivität.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
void setLocale(String withLocale)

Legen Sie das Gebietsschema für dieses Kontextobjekt fest.
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Ersetzt eine vorhandene Aktivität.

Geerbte Methoden von 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

Details zum Konstruktor

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Erstellt ein Kontextobjekt.

Parameter:

withAdapter - Der Adapter, der den Kontext erstellt.
withActivity - Die eingehende Aktivität für die Drehung; oder null für eine Aktivierung einer proaktiven Nachricht.

Details zur Methode

close

public void close()

AutoClosable#close.

Löst aus:

java.lang.Exception - Wenn die TurnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Löscht eine vorhandene Aktivität. Die ConversationReference#getActivityId der Unterhaltungsreferenz gibt die Zu löschende Aktivität in der Unterhaltung an.

Parameter:

conversationReference - Die Unterhaltung, die die zu löschende Aktivität enthält.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

deleteActivity

public CompletableFuture deleteActivity(String activityId)

Löscht eine vorhandene Aktivität.

Parameter:

activityId - Die ID der zu löschenden Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

finalize

public void finalize()

Automatischer Aufruf von #close.

Überschreibt:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Ruft die Aktivität ab, die dieser Turn zugeordnet ist; oder null beim Verarbeiten einer proaktiven Nachricht.

getAdapter

public BotAdapter getAdapter()

Ruft den Botadapter ab, der dieses Kontextobjekt erstellt hat.

Gibt zurück:

Der BotAdaptor für diese Drehung.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Ruft eine Liste der Aktivitäten ab, die gesendet werden sollen, wenn "Kontext" ist. Activity.DeliveryMode == 'expectReplies'.

Gibt zurück:

Eine Liste der Aktivitäten.

getLocale

public String getLocale()

Ruft das Gebietsschema für dieses Kontextobjekt ab.

Gibt zurück:

Die Zeichenfolge des Gebietsschemas für dieses Kontextobjekt.

getResponded

public boolean getResponded()

Gibt an, ob mindestens eine Antwort für die aktuelle Drehung gesendet wurde.

Gibt zurück:

true, wenn mindestens eine Antwort für die aktuelle Drehung gesendet wurde.

getTurnState

public TurnContextStateCollection getTurnState()

Ruft die für dieses Kontextobjekt registrierten Dienste ab.

Gibt zurück:

die TurnContextStateCollection für diese Drehung.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

Fügt einen Antworthandler für Löschaktivitätsvorgänge hinzu.

Parameter:

handler - Der Handler, der dem Kontextobjekt hinzugefügt werden soll.

Gibt zurück:

Das aktualisierte Kontextobjekt.

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

Fügt einen Antworthandler für Sendeaktivitätsvorgänge hinzu.

Parameter:

handler - Der Handler, der dem Kontextobjekt hinzugefügt werden soll.

Gibt zurück:

Das aktualisierte Kontextobjekt.

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

Fügt einen Antworthandler für Aktualisierungsaktivitätsvorgänge hinzu.

Parameter:

handler - Der Handler, der dem Kontextobjekt hinzugefügt werden soll.

Gibt zurück:

Das aktualisierte Kontextobjekt.

sendActivities

public CompletableFuture sendActivities(List activities)

Sendet eine Reihe von Aktivitäten an den Absender der eingehenden Aktivität.

Parameter:

activities - Die zu sendenden Aktivitäten.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn die Aktivitäten erfolgreich gesendet werden, enthält das Aufgabenergebnis ein Array von ResourceResponse Objekten, die die IDs enthalten, die dem empfangenden Kanal den Aktivitäten zugewiesen wurden.

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

Sendet eine Aktivität an den Absender der eingehenden Aktivität.

Parameter:

activityToSend - Die zu sendende Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.

Wenn die Aktivität erfolgreich gesendet wird, enthält das Aufgabenergebnis ein ResourceResponse Objekt mit der ID, die der empfangende Kanal der Aktivität zugewiesen hat.

In der Dokumentation des Kanals finden Sie Beschränkungen, die für die Inhalte von textReplyToSendgelten.

Parameter:

textReplyToSend - Der Text der zu sendenden Nachricht.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.

Wenn die Aktivität erfolgreich gesendet wird, enthält das Aufgabenergebnis ein ResourceResponse Objekt mit der ID, die der empfangende Kanal der Aktivität zugewiesen hat.

In der Dokumentation des Kanals finden Sie Beschränkungen, die für die Inhalte von textReplyToSendgelten.

Parameter:

textReplyToSend - Der Text der zu sendenden Nachricht.
speak - Um verschiedene Merkmale der Spracherkennung Ihres Bots zu steuern, z. B. Sprachrate, Lautstärke, Aussprache und Pitch, geben Sie das SSML-Format (Speech Synthesis Markup Language) an.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivity

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

Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.

Wenn die Aktivität erfolgreich gesendet wird, enthält das Aufgabenergebnis ein ResourceResponse Objekt mit der ID, die der empfangende Kanal der Aktivität zugewiesen hat.

In der Dokumentation des Kanals finden Sie Beschränkungen, die für die Inhalte von textReplyToSendgelten.

Parameter:

textReplyToSend - Der Text der zu sendenden Nachricht.
speak - Um verschiedene Merkmale der Spracherkennung Ihres Bots zu steuern, z. B. Sprachrate, Lautstärke, Aussprache und Pitch, geben Sie das SSML-Format (Speech Synthesis Markup Language) an.
inputHint - (Optional) Eingabehinweis.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

setLocale

public void setLocale(String withLocale)

Legen Sie das Gebietsschema für dieses Kontextobjekt fest.

Parameter:

withLocale - Die Zeichenfolge des Gebietsschemas für dieses Kontextobjekt.

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

Ersetzt eine vorhandene Aktivität.

Parameter:

withActivity - Neue Ersetzungsaktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: