ActivityHandler Classe

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Crea un oggetto InvokeResponse riuscito con il corpo specificato.

Parametri:

Restituisce:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

Richiamato quando il bot invia un'azione scheda adattiva.

Parametri:

Restituisce:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività di comando quando viene usato il comportamento di base di onTurn(TurnContext turnContext). I comandi sono richieste per eseguire un'azione e i ricevitori rispondono in genere con una o più attività commandResult. I ricevitori devono anche rifiutare in modo esplicito le attività di comando non supportate.

Parametri:

Restituisce:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività CommandResult quando viene usato il comportamento di base di onTurn(TurnContext turnContext). Le attività CommandResult possono essere usate per comunicare il risultato di un'esecuzione del comando.

Parametri:

Restituisce:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività di aggiornamento della conversazione dal canale quando viene usato il comportamento di base di onTurn(TurnContext turnContext).

Le attività di aggiornamento della conversazione sono utili quando si tratta di rispondere agli utenti aggiunti o rimossi dalla conversazione.

Ad esempio, un bot potrebbe rispondere a un utente aggiunto salutando l'utente. Per impostazione predefinita, questo metodo chiamerà onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) se gli utenti sono stati aggiunti o onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) se sono stati rimossi utenti. Il metodo controlla l'ID membro in modo che risponda solo agli aggiornamenti relativi ai membri diversi dal bot stesso.

Parametri:

Restituisce:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica specifica per le attività di ActivityTypes.END_OF_CONVERSATION.

Parametri:

Restituisce:

protected CompletableFuture onEvent(TurnContext turnContext)

Richiamato quando viene ricevuto un evento diverso da token/risposta quando viene usato il comportamento di base di onEventActivity(TurnContext turnContext).

Questo metodo può facoltativamente essere sottoposto a override se il bot deve gestire eventi vari.

Per impostazione predefinita, questo metodo non esegue alcuna operazione.

Quando il metodo onEventActivity(TurnContext turnContext) riceve un evento con un Activity#getName() diverso da "token/risposta", chiama questo metodo.

Parametri:

Restituisce:

protected CompletableFuture onEventActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività evento dal connettore quando viene usato il comportamento di base di onTurn(TurnContext turnContext).

Le attività degli eventi possono essere usate per comunicare molte cose diverse.

Per impostazione predefinita, questo metodo chiamerà onTokenResponseEvent(TurnContext turnContext) se il nome dell'attività è "token/risposta" o onEvent(TurnContext turnContext) in caso contrario. L'evento "token/risposta" può essere attivato da un com.microsoft.bot.schema.OAuthCard.

Quando il metodo onTurn(TurnContext turnContext) riceve un'attività evento, chiama questo metodo.

Se l'evento Activity#getName è "token/risposta", chiama onTokenResponseEvent(TurnContext turnContext) in caso contrario, chiama onEvent(TurnContext turnContext).

In una classe derivata eseguire l'override di questo metodo per aggiungere logica applicabile a tutte le attività evento. Aggiungere la logica da applicare prima della logica di gestione degli eventi specifica prima della chiamata al metodo della classe di base. Aggiungere la logica da applicare dopo la logica di gestione degli eventi specifica dopo la chiamata al metodo della classe di base.

Le attività evento comunicano informazioni a livello di codice da un client o da un canale a un bot. Il significato di un'attività evento è definito dalla proprietà Activity#getName, che è significativa nell'ambito di un canale. Un evento "token/risposta" può essere attivato da un com.microsoft.bot.schema.OAuthCard o da un prompt OAuth.

Parametri:

Restituisce:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica specifica per le attività ActivityTypes.InstallationUpdate.

Parametri:

Restituisce:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

Eseguire l'override di questo elemento in una classe derivata per fornire la logica specifica per le attività ActivityTypes.InstallationUpdate con 'action' impostata su 'add'.

Parametri:

Restituisce:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

Eseguire l'override di questo elemento in una classe derivata per fornire la logica specifica per le attività ActivityTypes.InstallationUpdate con 'action' impostata su 'remove'.

Parametri:

Restituisce:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività invoke dal connettore quando viene usato il comportamento di base di onTurn.

Le attività invoke possono essere usate per comunicare molte cose diverse. Per impostazione predefinita, questo metodo chiamerà onSignInInvokeAsync se il nome dell'attività è "signin/verifyState" o "signin/tokenExchange".

Una chiamata 'signin/verifyState' o 'signin/tokenExchange' può essere attivata da un OAuthCard.

Parametri:

Restituisce:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica per quando i membri diversi dal bot partecipano alla conversazione, ad esempio la logica di benvenuto del bot.

Quando il metodo onConversationUpdateActivity(TurnContext turnContext) riceve un'attività di aggiornamento della conversazione che indica che uno o più utenti diversi dal bo partecipano alla conversazione, chiama questo metodo.

Parametri:

Restituisce:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica per quando i membri diversi dal bot lasciano la conversazione, ad esempio la logica good-bye del bot.

Quando il metodo onConversationUpdateActivity(TurnContext turnContext) riceve un'attività di aggiornamento della conversazione che indica uno o più utenti diversi dal bot lasciano la conversazione, chiama questo metodo.

Parametri:

Restituisce:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica specifica per ActivityTypes#MESSAGE attività, ad esempio la logica di conversazione.

Quando il metodo onTurn(TurnContext turnContext) riceve un'attività di messaggio, chiama questo metodo.

Parametri:

Restituisce:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Richiamato quando viene ricevuta un'attività evento dal connettore quando viene usato il comportamento di base di onTurn(TurnContext turnContext).

Le reazioni ai messaggi corrispondono all'utente aggiungendo un 'like' o 'sad' ecc. (spesso un'emoji) a un'attività inviata in precedenza. Le reazioni ai messaggi sono supportate solo da alcuni canali.

L'attività a cui corrisponde la reazione del messaggio è indicata nella proprietà replyToId. Il valore di questa proprietà è l'ID attività di un'attività inviata in precedenza restituita al bot come risposta da una chiamata di invio.

Quando il metodo onTurn(TurnContext turnContext) riceve un'attività di reazione al messaggio, chiama questo metodo. Se la reazione al messaggio indica che le reazioni sono state aggiunte a un messaggio, chiama onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). Se la reazione al messaggio indica che le reazioni sono state rimosse da un messaggio, chiama onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).

In una classe derivata eseguire l'override di questo metodo per aggiungere logica applicabile a tutte le attività di reazione al messaggio. Aggiungere la logica da applicare prima che le reazioni aggiunte o rimosse la logica prima della chiamata al metodo della classe base. Aggiungere la logica da applicare dopo l'aggiunta o la rimozione della logica dopo la chiamata alla classe base.

Parametri:

Restituisce:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

Eseguire l'override di questo oggetto in una classe derivata per fornire la logica per quando le reazioni a un'attività precedente vengono aggiunte alla conversazione.

Le reazioni ai messaggi corrispondono all'utente aggiungendo un messaggio "like" o "sad" e così via (spesso un'emoji) a un messaggio inviato in precedenza nella conversazione. Le reazioni ai messaggi sono supportate solo da pochi canali. L'attività a cui il messaggio è in reazione viene identificata dalla proprietà Activity#getReplyToId() dell'attività. Il valore di questa proprietà è l'ID attività di un'attività inviata in precedenza. Quando il bot invia un'attività, il canale assegna un ID, disponibile nella com.microsoft.bot.schema.ResourceResponse#getId del risultato.

Parametri:

Restituisce:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

Eseguire l'override di questo oggetto in una classe derivata per fornire la logica per quando le reazioni a un'attività precedente vengono rimosse dalla conversazione.

Le reazioni ai messaggi corrispondono all'utente aggiungendo un messaggio "like" o "sad" e così via (spesso un'emoji) a un messaggio inviato in precedenza nella conversazione. Le reazioni ai messaggi sono supportate solo da pochi canali. L'attività a cui il messaggio è in reazione viene identificata dalla proprietà Activity#getReplyToId() dell'attività. Il valore di questa proprietà è l'ID attività di un'attività inviata in precedenza. Quando il bot invia un'attività, il canale assegna un ID, disponibile nella com.microsoft.bot.schema.ResourceResponse#getId del risultato.

Parametri:

Restituisce:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Richiamato quando viene ricevuto un evento 'signin/verifyState' o 'signin/tokenExchange' quando viene usato il comportamento di base di onInvokeActivity.

Se si usa un OAuthPrompt, eseguire l'override di questo metodo per inoltrare questa attività alla finestra di dialogo corrente. Per impostazione predefinita, questo metodo non esegue alcuna operazione.

Quando il metodo onInvokeActivity riceve un oggetto Invoke con un nome "tokens/response", chiama questo metodo.

Se il bot usa OAuthPrompt, inoltrare l'attività in ingresso alla finestra di dialogo corrente.

Parametri:

Restituisce:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Richiamato quando viene ricevuto un evento "token/risposta" quando viene usato il comportamento di base di onEventActivity(TurnContext turnContext).

Se si usa OAuthPrompt, eseguire l'override di questo metodo per inoltrare questo Activity alla finestra di dialogo corrente.

Per impostazione predefinita, questo metodo non esegue alcuna operazione.

Quando il metodo onEventActivity(TurnContext turnContext) riceve un evento con un Activity#getName() di "token/risposta", chiama questo metodo.

Parametri:

Restituisce:

public CompletableFuture onTurn(TurnContext turnContext)

Chiamato dall'adapter (ad esempio, un BotFrameworkAdapter) in fase di esecuzione per elaborare un Activityin ingresso.

Questo metodo chiama altri metodi in questa classe in base al tipo dell'attività da elaborare, che consente a una classe derivata di fornire logica specifica del tipo in modo controllato.

In una classe derivata eseguire l'override di questo metodo per aggiungere logica applicabile a tutti i tipi di attività. Aggiungere la logica da applicare prima della logica specifica del tipo prima della chiamata al metodo onTurn(TurnContext turnContext) della classe base. Aggiungere la logica da applicare dopo la logica specifica del tipo dopo la chiamata alla classe base onTurn(TurnContext turnContext) metodo.

Parametri:

Restituisce:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

Eseguire l'override in una classe derivata per fornire logica specifica per le attività ActivityTypes.Typing.

Parametri:

Restituisce:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

Richiamato quando viene usata un'attività diversa da un messaggio, un aggiornamento della conversazione o un evento quando viene usato il comportamento di base di onTurn(TurnContext turnContext).

Se sottoposto a override, potrebbe rispondere a qualsiasi altro tipo di attività, ad esempio com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE o com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION.

Per impostazione predefinita, questo metodo non esegue alcuna operazione.

Quando il metodo onTurn(TurnContext turnContext) riceve un'attività che non è un messaggio, un aggiornamento della conversazione, una reazione al messaggio o un'attività evento, chiama questo metodo.

Parametri:

Restituisce: