BotAdapter Classe

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

public abstract class BotAdapter

Rappresenta un adattatore bot in grado di connettere un bot a un endpoint di servizio. Questa classe è astratta.

L'adapter bot incapsula i processi di autenticazione e invia attività a e riceve attività dal servizio Bot Connector. Quando il bot riceve un'attività, l'adapter crea un oggetto contesto, lo passa alla logica dell'applicazione del bot e invia le risposte al canale dell'utente.

Utilizzare use(Middleware middleware) per aggiungere oggetti Middleware all'adattatore\u2019raccolta middleware. L'adattatore elabora e indirizza le attività in ingresso nella pipeline del middleware del bot al bot\u2019logica e quindi torna indietro. Man mano che ogni attività scorre all'interno e all'esterno del bot, ogni parte del middleware può esaminare o agire sull'attività, sia prima che dopo l'esecuzione della logica del bot.

TurnContext Activity Bot Middleware

Riepilogo dei campi

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

Chiave per archiviare l'identità delle attestazioni del bot.
static final java.lang.String OAUTH_CLIENT_KEY

Chiave per archiviare il client oauth del bot.
static final java.lang.String OAUTH_SCOPE_KEY

Chiave per archiviare l'ambito oauth del bot.

Riepilogo dei costruttori

Costruttore Descrizione
BotAdapter()

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

Quando sottoposto a override in una classe derivata, elimina un'attività esistente nella conversazione.
protected MiddlewareSet getMiddlewareSet()

Ottiene la raccolta di middleware nella pipeline dell'adattatore.
OnTurnErrorHandler getOnTurnError()

Ottiene il gestore degli errori che può intercettare le eccezioni nel middleware o nell'applicazione.
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

Avvia l'elaborazione delle attività per il turno corrente del bot.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

Quando sottoposto a override in una classe derivata, invia attività alla conversazione.
void setOnTurnError(OnTurnErrorHandler withTurnError)

Imposta il gestore degli errori in grado di rilevare le eccezioni nel middleware o nell'applicazione.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

Quando sottoposto a override in una classe derivata, sostituisce un'attività esistente nella conversazione.
BotAdapter use(Middleware middleware)

Aggiunge middleware alla pipeline dell'adapter.

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 del campo

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Chiave per archiviare l'identità delle attestazioni del bot.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Chiave per archiviare il client oauth del bot.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Chiave per archiviare l'ambito oauth del bot.

Dettagli costruttore

BotAdapter

public BotAdapter()

Dettagli metodo

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Parametri:

claimsIdentity - AttestazioniIdentity per la conversazione.
continuationActivity - Un'attività con l'oggetto ConversationReference appropriato con cui continuare la conversazione.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Parametri:

claimsIdentity - AttestazioniIdentity per la conversazione.
continuationActivity - Un'attività con l'oggetto ConversationReference appropriato con cui continuare la conversazione.
audience - Valore che indica il destinatario del messaggio proattivo.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Parametri:

claimsIdentity - Riferimento claimsIdentity per la conversazione.
reference - Riferimento alla conversazione da continuare.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Parametri:

claimsIdentity - Riferimento claimsIdentity per la conversazione.
reference - Riferimento alla conversazione da continuare.
audience - Valore che indica il destinatario del messaggio proattivo.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Parametri:

botId - ID applicazione del bot. Questo parametro viene ignorato in un singolo tenant gli adapter (console, test e così via), ma è fondamentale per BotFrameworkAdapter, che è compatibile con più tenant.
continuationActivity - Un'attività con l'oggetto ConversationReference appropriato con cui continuare la conversazione.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Invia un messaggio proattivo a una conversazione.

Parametri:

botAppId - ID applicazione del bot. Questo parametro viene ignorato in un singolo tenant gli adapter (console, test e così via), ma è fondamentale per BotFrameworkAdapter, che è compatibile con più tenant.
reference - Riferimento alla conversazione da continuare.
callback - Metodo da chiamare per il turno del bot risultante.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente. 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Quando sottoposto a override in una classe derivata, elimina un'attività esistente nella conversazione.

Parametri:

context - Oggetto di contesto per il turno.
reference - Informazioni di riferimento sulla conversazione per l'attività da eliminare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Il ConversationReference#getActivityId del riferimento alla conversazione identifica l'attività da eliminare. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Ottiene la raccolta di middleware nella pipeline dell'adattatore.

Restituisce:

Raccolta middleware per la pipeline.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Ottiene il gestore degli errori che può intercettare le eccezioni nel middleware o nell'applicazione.

Restituisce:

Gestore degli errori che può intercettare le eccezioni nel middleware o nell'applicazione.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Avvia l'elaborazione delle attività per il turno corrente del bot. L'adattatore chiama middleware nell'ordine in cui è stato aggiunto. L'adattatore passa l'oggetto contesto per il turno e un delegato successivo e il middleware chiama il delegato per passare il controllo al middleware successivo nella pipeline. Quando il controllo raggiunge la fine della pipeline, l'adattatore chiama il metodo callback. Se un componente middleware non chiama il delegato successivo, l'adattatore non chiama alcuno del middleware successivo\u2019i metodi onTurn(TurnContext turnContext, NextDelegate next) o il metodo di callback e i corto circuito della pipeline.

Quando il turno viene avviato da un'attività utente (messaggistica reattiva), il metodo di callback sarà un riferimento al metodo onTurn(TurnContext turnContext) del bot. Quando il turno viene avviato da una chiamata a continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (messaggistica proattiva), il metodo di callback è il metodo di callback fornito nella chiamata.

Parametri:

context - Oggetto contesto del turno.
callback - Metodo di callback da eseguire alla fine della pipeline.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

Quando sottoposto a override in una classe derivata, invia attività alla conversazione.

Parametri:

context - Oggetto di contesto per il turno.
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à. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Imposta il gestore degli errori in grado di rilevare le eccezioni nel middleware o nell'applicazione.

Parametri:

withTurnError - Gestore degli errori che può intercettare le eccezioni nel middleware o nell'applicazione.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

Quando sottoposto a override in una classe derivata, sostituisce un'attività esistente nella conversazione.

Parametri:

context - Oggetto di contesto per il turno.
activity - Nuova attività sostitutiva.

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

Prima di chiamare questa operazione, impostare l'ID dell'attività di sostituzione sull'ID dell'attività da sostituire. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Aggiunge middleware alla pipeline dell'adapter.

Parametri:

middleware - Middleware da aggiungere.

Restituisce:

Oggetto adapter aggiornato. Il middleware viene aggiunto all'adapter in fase di inizializzazione. Per ogni turno, l'adattatore chiama middleware nell'ordine in cui è stato aggiunto.

Si applica a