TurnContextImpl Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.builder
Artefatto Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.TurnContextImpl

Implementazioni

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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 costruttori

Costruttore Descrizione
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crea un oggetto contesto.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
void close()

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

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

Elimina un'attività esistente.
void finalize()

Chiamata automatica di #close.
Activity getActivity()

Ottiene l'attività associata a questo turno; o null durante l'elaborazione di un messaggio proattivo.
BotAdapter getAdapter()

Ottiene l'adattatore bot che ha creato questo oggetto contesto.
java.util.List<Activity> getBufferedReplyActivities()

Ottiene un elenco di attività da inviare quando il contesto.'attività.modalitàrecapito == 'aspettatevi risposte'.
java.lang.String getLocale()

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

Indica se è stata inviata almeno una risposta per il turno corrente.
TurnContextStateCollection getTurnState()

Ottiene i servizi registrati in questo oggetto contesto.
TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

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

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

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

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

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

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

Invia un'attività di messaggio al mittente dell'attività in ingresso.
void setLocale(String withLocale)

Impostare le impostazioni locali in questo oggetto di contesto.
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Sostituisce un'attività esistente.

Metodi ereditati da 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

Dettagli costruttore

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crea un oggetto contesto.

Parametri:

withAdapter - Adattatore che crea il contesto.
withActivity - L'attività in ingresso per il turno; o null per un turno per un messaggio proattivo.

Dettagli metodo

close

public void close()

AutoClosable#close.

Genera un'eccezione:

java.lang.Exception - Se TurnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Elimina un'attività esistente. Il ConversationReference#getActivityId del riferimento di conversazione indica l'attività nella conversazione da eliminare.

Parametri:

conversationReference - Conversazione contenente l'attività da eliminare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

deleteActivity

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

finalize

public void finalize()

Chiamata automatica di #close.

Override:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Ottiene l'attività associata a questo turno; o null durante l'elaborazione di un messaggio proattivo.

getAdapter

public BotAdapter getAdapter()

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

Restituisce:

BotAdaptor per questo turno.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Ottiene un elenco di attività da inviare quando il contesto. Activity.DeliveryMode == 'expectReplies'.

Restituisce:

Elenco di attività.

getLocale

public String getLocale()

Ottiene le impostazioni locali in questo oggetto di contesto.

Restituisce:

Stringa di impostazioni locali in questo oggetto contesto.

getResponded

public boolean getResponded()

Indica se è stata inviata almeno una risposta per il turno corrente.

Restituisce:

true se è stata inviata almeno una risposta per il turno corrente.

getTurnState

public TurnContextStateCollection getTurnState()

Ottiene i servizi registrati in questo oggetto contesto.

Restituisce:

TurnContextStateCollection per questo turno.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Parametri:

handler - Gestore da aggiungere all'oggetto contesto.

Restituisce:

Oggetto contesto aggiornato.

sendActivities

public CompletableFuture sendActivities(List activities)

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

Parametri:

activities - Attività da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. 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à.

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

Parametri:

activityToSend - Attività da inviare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivity

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

Parametri:

textReplyToSend - Testo del messaggio da inviare.
speak - Per controllare varie caratteristiche del parlato del bot, ad esempio velocità vocale, volume, pronuncia e passo, specificare il formato SSML (Speech Synthesis Markup Language).

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivity

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

Parametri:

textReplyToSend - Testo del messaggio da inviare.
speak - Per controllare varie caratteristiche del parlato del bot, ad esempio velocità vocale, volume, pronuncia e passo, specificare il formato SSML (Speech Synthesis Markup Language).
inputHint - (Facoltativo) Suggerimento di input.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

setLocale

public void setLocale(String withLocale)

Impostare le impostazioni locali in questo oggetto di contesto.

Parametri:

withLocale - Stringa di impostazioni locali in questo oggetto contesto.

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

Sostituisce un'attività esistente.

Parametri:

withActivity - Nuova attività sostitutiva.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

Si applica a