TurnContext Interfaccia

  • Riferimento
Pacchetto:
com.microsoft.bot.builder
Artefatto Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

Fornisce il contesto per un turno di un bot.

Il contesto fornisce informazioni necessarie per elaborare un'attività in ingresso. L'oggetto contesto viene creato da un BotAdapter e viene mantenuto per la lunghezza del turno.

Bot Middleware

Riepilogo dei campi

Modificatore e tipo Campo e descrizione
static final java.lang.String STATE_TURN_LOCALE

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

Elimina un'attività esistente.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

Elimina un'attività esistente.
abstract Activity getActivity()

Ottiene l'attività per questo turno del bot.
abstract BotAdapter getAdapter()

Ottiene l'adattatore bot che ha creato questo oggetto contesto.
abstract java.lang.String getLocale()

Ottiene le impostazioni locali in questo oggetto di contesto.
abstract boolean getResponded()

Ottiene un valore che indica se è stata inviata almeno una risposta per il turno corrente.
abstract TurnContextStateCollection getTurnState()

Ottiene la raccolta di valori memorizzati nella cache con l'oggetto contesto per la durata del turno.
abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Aggiunge un gestore di risposta per le operazioni di eliminazione delle attività.
abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Aggiunge un gestore di risposta per le operazioni di invio dell'attività.
abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Aggiunge un gestore di risposta per le operazioni di aggiornamento dell'attività.
default java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(Activity[] activities)

Metodo helper per inviare una matrice di attività.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

Invia un elenco di attività al mittente dell'attività in ingresso.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activity)

Invia un'attività al mittente dell'attività in ingresso.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

Invia un'attività di messaggio al mittente dell'attività in ingresso.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

Invia un'attività di messaggio al mittente dell'attività in ingresso.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Invia un'attività di messaggio al mittente dell'attività in ingresso.
default java.util.concurrent.CompletableFuture<java.lang.Void> sendActivityBlind(Activity activity)

Invia un'attività al mittente dell'attività in ingresso senza restituire una risorsarisposta.
abstract void setLocale(String withLocale)

Impostare le impostazioni locali in questo oggetto di contesto.
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)

Invia un'attività di traccia al BotAdapter a scopo di registrazione.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Sostituisce un'attività esistente.

Dettagli del campo

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Dettagli metodo

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Elimina un'attività esistente.

Parametri:

conversationReference - Conversazione contenente l'attività da eliminare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Il ConversationReference#getActivityId del riferimento di conversazione indica l'attività nella conversazione da eliminare.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

Elimina un'attività esistente.

Parametri:

activityId - ID dell'attività da eliminare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

getActivity

public abstract Activity getActivity()

Ottiene l'attività per questo turno del bot.

Restituisce:

L'attività per questo turno del bot.

getAdapter

public abstract BotAdapter getAdapter()

Ottiene l'adattatore bot che ha creato questo oggetto contesto.

Restituisce:

Adattatore bot che ha creato questo oggetto contesto.

getLocale

public abstract String getLocale()

Ottiene le impostazioni locali in questo oggetto di contesto.

Restituisce:

Stringa di impostazioni locali in questo oggetto contesto.

getResponded

public abstract boolean getResponded()

Ottiene un valore che indica se è stata inviata almeno una risposta per il turno corrente.

Restituisce:

true se è stata inviata almeno una risposta per il turno corrente; in caso contrario, false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Ottiene la raccolta di valori memorizzati nella cache con l'oggetto contesto per la durata del turno.

Restituisce:

Raccolta di servizi registrati in questo oggetto contesto.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Aggiunge un gestore di risposta per le operazioni di eliminazione delle attività.

Quando viene chiamato il deleteActivity(String activityId) del contesto, l'adattatore chiama i gestori registrati nell'ordine in cui sono stati aggiunti all'oggetto contesto.

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Aggiunge un gestore di risposta per le operazioni di invio dell'attività.

Quando vengono chiamati i metodi sendActivity(Activity activity) o sendActivities(List<Activity> activities) del contesto, l'adattatore chiama i gestori registrati nell'ordine in cui sono stati aggiunti all'oggetto contesto.

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Aggiunge un gestore di risposta per le operazioni di aggiornamento dell'attività.

Quando viene chiamato il updateActivity(Activity withActivity) del contesto, l'adattatore chiama i gestori registrati nell'ordine in cui sono stati aggiunti all'oggetto contesto.

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Metodo helper per inviare una matrice di attività. Viene chiamato sendActivities(List<Activity> activities).

Parametri:

activities - Matrice di attività.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Invia un elenco di attività al mittente dell'attività in ingresso.

Se le attività vengono inviate correttamente, il risultato dell'attività contiene una matrice di oggetti ResourceResponse contenenti gli ID assegnati al canale ricevente alle attività.

Parametri:

activities - Attività da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Invia un'attività al mittente dell'attività in ingresso.

Parametri:

activity - Attività da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Invia un'attività di messaggio al mittente dell'attività in ingresso.

Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività.

Vedere la documentazione del canale per i limiti imposti al contenuto di textReplyToSend.

Parametri:

textReplyToSend - Testo del messaggio da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Invia un'attività di messaggio al mittente dell'attività in ingresso.

Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività.

Vedere la documentazione del canale per i limiti imposti al contenuto di textReplyToSend.

Per controllare varie caratteristiche del parlato del bot, ad esempio voce, frequenza, volume, pronuncia e passo, specificare speak in formato SSML (Speech Synthesis Markup Language).

Parametri:

textReplyToSend - Testo del messaggio da inviare.
speak - Facoltativo, testo da pronunciare dal bot in un canale abilitato per il riconoscimento vocale.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivity

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

Invia un'attività di messaggio al mittente dell'attività in ingresso.

Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività.

Vedere la documentazione del canale per i limiti imposti al contenuto di textReplyToSend.

Per controllare varie caratteristiche del parlato del bot, ad esempio voce, frequenza, volume, pronuncia e passo, specificare speak in formato SSML (Speech Synthesis Markup Language).

Parametri:

textReplyToSend - Testo del messaggio da inviare.
speak - Facoltativo, testo da pronunciare dal bot in un canale abilitato per il riconoscimento vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Uno di: "accettaInput", "ignoringInput" o "expectingInput". Il valore predefinito è "accettaInput".

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Invia un'attività al mittente dell'attività in ingresso senza restituire un oggetto ResourceResponse.

Parametri:

activity - Attività da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

setLocale

public abstract void setLocale(String withLocale)

Impostare le impostazioni locali in questo oggetto di contesto.

Parametri:

withLocale - Stringa di impostazioni locali in questo oggetto contesto.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parametri:

turnContext - TurnContext.
name - Nome dell'attività.

Restituisce:

Un futuro con ResourceReponse.

traceActivity

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

Invia un'attività di traccia al BotAdapter a scopo di registrazione.

Parametri:

turnContext - Contesto per il turno corrente.
name - Valore da assegnare alla proprietà Activity#getName dell'attività.
value - Valore da assegnare alla proprietà Activity#getValue dell'attività.
valueType - Valore da assegnare alla proprietà Activity#getValueType dell'attività.
label - Valore da assegnare alla proprietà Activity#getLabel dell'attività.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Se l'adattatore è ospitato nell'emulatore, il risultato dell'attività contiene un oggetto ResourceResponse con l'ID dell'attività di traccia originale; in caso contrario, contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente assegnato all'attività.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Sostituisce un'attività esistente.

Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività.

Prima di chiamare questa operazione, impostare l'ID dell'attività di sostituzione sull'ID dell'attività da sostituire.

Parametri:

withActivity - Nuova attività sostitutiva.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

Si applica a