TurnContext Schnittstelle

Paket:

com.microsoft.bot.builder

Maven-Artefakt:

com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

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

Feldzusammenfassung

Modifizierer und Typ	Feld und Beschreibung
static final java.lang.String	STATE_TURN_LOCALE

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Löscht eine vorhandene Aktivität.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Löscht eine vorhandene Aktivität.
abstract Activity	getActivity() Ruft die Aktivität für diese Drehung des Bots ab.
abstract BotAdapter	getAdapter() Ruft den Botadapter ab, der dieses Kontextobjekt erstellt hat.
abstract java.lang.String	getLocale() Ruft das Gebietsschema für dieses Kontextobjekt ab.
abstract boolean	getResponded() Ruft einen Wert ab, der angibt, ob mindestens eine Antwort für die aktuelle Drehung gesendet wurde.
abstract TurnContextStateCollection	getTurnState() Ruft die Auflistung von Werten ab, die mit dem Kontextobjekt für die Lebensdauer der Drehung zwischengespeichert wurden.
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) Fügt einen Antworthandler für Löschaktivitätsvorgänge hinzu.
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) Fügt einen Antworthandler für Sendeaktivitätsvorgänge hinzu.
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) Fügt einen Antworthandler für Aktualisierungsaktivitätsvorgänge hinzu.
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) Hilfsmethode zum Senden eines Arrays von Aktivitäten.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Sendet eine Liste der Aktivitäten an den Absender der eingehenden Aktivität.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) Sendet eine Aktivität an den Absender der eingehenden Aktivität.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Sendet eine Nachrichtenaktivität an den Absender der eingehenden Aktivität.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendActivityBlind(Activity activity) Sendet eine Aktivität an den Absender der eingehenden Aktivität, ohne eine RessourceAntwort zurückzugeben.
abstract void	setLocale(String withLocale) Legen Sie das Gebietsschema für dieses Kontextobjekt fest.
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) Sendet eine Ablaufverfolgungsaktivität zur Protokollierung an die BotAdapter.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Ersetzt eine vorhandene Aktivität.

Felddetails

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Details zur Methode

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Löscht eine vorhandene Aktivität.

Parameter:

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

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Die ConversationReference#getActivityId der Unterhaltungsreferenz gibt die Zu löschende Aktivität in der Unterhaltung an.

deleteActivity

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

getActivity

public abstract Activity getActivity()

Ruft die Aktivität für diese Drehung des Bots ab.

Gibt zurück:

Die Aktivität für diese Drehung des Bots.

getAdapter

public abstract BotAdapter getAdapter()

Ruft den Botadapter ab, der dieses Kontextobjekt erstellt hat.

Gibt zurück:

Der Botadapter, der dieses Kontextobjekt erstellt hat.

getLocale

public abstract String getLocale()

Ruft das Gebietsschema für dieses Kontextobjekt ab.

Gibt zurück:

Die Zeichenfolge des Gebietsschemas für dieses Kontextobjekt.

getResponded

public abstract boolean getResponded()

Ruft einen Wert ab, der angibt, 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; andernfalls false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Ruft die Auflistung von Werten ab, die mit dem Kontextobjekt für die Lebensdauer der Drehung zwischengespeichert wurden.

Gibt zurück:

Die Auflistung der dienste, die für dieses Kontextobjekt registriert sind.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Wenn die deleteActivity(String activityId) des Kontexts aufgerufen wird, ruft der Adapter die registrierten Handler in der Reihenfolge auf, in der sie dem Kontextobjekt hinzugefügt wurden.

Parameter:

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

Gibt zurück:

Das aktualisierte Kontextobjekt.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

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

Wenn die sendActivity(Activity activity)- oder sendActivities(List<Activity> activities) Methoden des Kontexts aufgerufen werden, ruft der Adapter die registrierten Handler in der Reihenfolge auf, in der sie dem Kontextobjekt hinzugefügt wurden.

Parameter:

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

Gibt zurück:

Das aktualisierte Kontextobjekt.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Wenn die updateActivity(Activity withActivity) des Kontexts aufgerufen wird, ruft der Adapter die registrierten Handler in der Reihenfolge auf, in der sie dem Kontextobjekt hinzugefügt wurden.

Parameter:

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

Gibt zurück:

Das aktualisierte Kontextobjekt.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Hilfsmethode zum Senden eines Arrays von Aktivitäten. Dadurch wird sendActivities(List<Activity> activities)aufgerufen.

Parameter:

activities - Das Array von Aktivitäten.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivities

public abstract CompletableFuture sendActivities(List activities)

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

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.

Parameter:

activities - Die zu sendenden Aktivitäten.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

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

Parameter:

activity - Die zu sendende Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. 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.

sendActivity

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

Geben Sie speak im SSML-Format (Speech Synthesis Markup Language) an, um verschiedene Merkmale der Sprache Ihres Bots zu steuern, z. B. Sprache, Rate, Lautstärke, Aussprache und Tonhöhe.

Parameter:

textReplyToSend - Der Text der zu sendenden Nachricht.

speak - Optionaler Text, der von Ihrem Bot in einem sprachfähigen Kanal gesprochen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivity

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

Geben Sie speak im SSML-Format (Speech Synthesis Markup Language) an, um verschiedene Merkmale der Sprache Ihres Bots zu steuern, z. B. Sprache, Rate, Lautstärke, Aussprache und Tonhöhe.

Parameter:

textReplyToSend - Der Text der zu sendenden Nachricht.

speak - Optionaler Text, der von Ihrem Bot in einem sprachfähigen Kanal gesprochen werden soll.

inputHint - Optional, gibt an, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client übermittelt wurde. Einer von: "acceptingInput", "ignoringInput" oder "expectingInput". Der Standardwert ist "acceptingInput".

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Sendet eine Aktivität an den Absender der eingehenden Aktivität, ohne eine ResourceResponse zurückzugeben.

Parameter:

activity - Die zu sendende Aktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

setLocale

public abstract void setLocale(String withLocale)

Legen Sie das Gebietsschema für dieses Kontextobjekt fest.

Parameter:

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

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parameter:

turnContext - Der turnContext.

name - Der Name der Aktivität.

Gibt zurück:

Eine Zukunft mit dem ResourceReponse.

traceActivity

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

Sendet eine Ablaufverfolgungsaktivität zur Protokollierung an die BotAdapter.

Parameter:

turnContext - Der Kontext für die aktuelle Drehung.

name - Der Wert, der der Activity#getName-Eigenschaft der Aktivität zugewiesen werden soll.

value - Der Wert, der der Activity#getValue-Eigenschaft der Aktivität zugewiesen werden soll.

valueType - Der Wert, der der Activity#getValueType-Eigenschaft der Aktivität zugewiesen werden soll.

label - Der Wert, der der Activity#getLabel-Eigenschaft der Aktivität zugewiesen werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn der Adapter im Emulator gehostet wird, enthält das Aufgabenergebnis ein ResourceResponse Objekt mit der ID der ursprünglichen Ablaufverfolgungsaktivität; andernfalls enthält es ein ResourceResponse-Objekt, das die ID enthält, die der empfangende Kanal der Aktivität zugewiesen wurde.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Ersetzt eine vorhandene 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.

Legen Sie vor dem Aufrufen die ID der Ersetzungsaktivität auf die ID der zu ersetzenden Aktivität fest.

Parameter:

withActivity - Neue Ersetzungsaktivität.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.