ActivityHandler Classe

Richiamato quando il bot invia un'azione scheda adattiva.

Quando il metodo on_invoke_activity riceve un oggetto Invoke con un Activity.name di adaptiveCard/action, chiama questo metodo.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

Parametri

Restituisce

Richiamato quando viene ricevuta un'attività di aggiornamento della conversazione dal canale quando viene usato il comportamento di base di on_turn.

async on_conversation_update_activity(turn_context: TurnContext)

Parametri

Restituisce

Commenti

Quando il metodo on_turn riceve un'attività di aggiornamento della conversazione, chiama questo metodo. Anche

• Se l'attività di aggiornamento della conversazione indica che i membri diversi dal bot sono stati aggiunti alla conversazione, chiama il metodo on_members_added_activity.
• Se l'attività di aggiornamento della conversazione indica che i membri diversi dal bot hanno lasciato la conversazione, chiama il metodo on_members_removed_activity.
• In una classe derivata eseguire l'override di questo metodo per aggiungere logica applicabile a tutte le attività di aggiornamento della conversazione. Aggiungere la logica da applicare prima dell'aggiunta o della rimozione della logica del membro prima della chiamata a questo metodo della classe di base.

Richiamato quando un'attività di fine conversazione viene ricevuta dal canale.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parametri

Restituisce

Richiamato quando viene ricevuto un evento diverso da token/ di risposta quando viene usato il comportamento di base di on_event_activity.

async on_event(turn_context: TurnContext)

Parametri

Restituisce

Commenti

Quando viene usato il metodo on_event_activity riceve un evento con un nome di attività diverso da token/risposta, chiama questo metodo. Questo metodo può facoltativamente essere sottoposto a override se il bot deve gestire eventi vari.

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

async on_event_activity(turn_context: TurnContext)

Parametri

Restituisce

Commenti

Quando il metodo on_turn riceve un'attività evento, chiama questo metodo. Se il nome dell'attività è token/risposta, chiama on_token_response_event; in caso contrario, chiama on_event.

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 a questo metodo della classe di base. Aggiungere la logica da applicare dopo la logica di gestione degli eventi specifica dopo la chiamata a questo 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à del nome dell'attività dell'evento, che è significativa nell'ambito di un canale.

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

async on_installation_update(turn_context: TurnContext)

Parametri

Restituisce

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

async on_installation_update_add(turn_context: TurnContext)

Parametri

Restituisce

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

async on_installation_update_remove(turn_context: TurnContext)

Parametri

Restituisce

Registra un gestore eventi di attività per l'evento invoke, generato per ogni attività evento in ingresso.

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

Parametri

Restituisce

Eseguire l'override di questo metodo in una classe derivata per fornire logica per quando i membri diversi dal bot partecipano alla conversazione. È possibile aggiungere la logica di benvenuto del bot.

attività di aggiornamento della conversazione:type members_added: List :p aram turn_context: L'oggetto contesto per questo turno :type turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

Parametri

Restituisce

Commenti

Quando il metodo on_conversation_update_activity riceve un'attività di aggiornamento della conversazione che indica uno o più utenti diversi dal bot partecipano alla conversazione, chiama questo metodo.

Eseguire l'override di questo metodo in una classe derivata per fornire logica per quando i membri diversi dal bot lasciano la conversazione. È possibile aggiungere la logica good-bye del bot.

attività di aggiornamento della conversazione:type members_added: List :p aram turn_context: L'oggetto contesto per questo turno :type turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

Parametri

Restituisce

Commenti

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

Eseguire l'override di questo metodo in una classe derivata per fornire logica specifica per le attività, ad esempio la logica di conversazione.

async on_message_activity(turn_context: TurnContext)

Parametri

Restituisce

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

async on_message_reaction_activity(turn_context: TurnContext)

Parametri

Restituisce

Commenti

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à Reply to Id. 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 on_turn riceve un'attività di reazione al messaggio, chiama questo metodo.

• Se la reazione del messaggio indica che le reazioni sono state aggiunte a un messaggio, chiama

<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_added>.

• Se la reazione al messaggio indica che le reazioni sono state rimosse da un messaggio, chiama <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

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 di base. Aggiungere la logica da applicare dopo l'aggiunta o la rimozione della logica dopo la chiamata al metodo della classe di base.

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

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parametri

Restituisce

Commenti

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 è identificata dalla risposta dell'attività alla proprietà ID. 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 nell'ID della risposta della risorsa del risultato.

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

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parametri

Restituisce

Commenti

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à Id di risposta 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 nell'ID della risposta della risorsa del risultato.

Richiamato quando viene ricevuto un evento signin/verifyState o signin/tokenExchange quando viene utilizzato il comportamento di base di on_invoke_activity(TurnContext{InvokeActivity}). 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.

async on_sign_in_invoke(turn_context: TurnContext)

Parametri

Restituisce

Richiamato quando viene ricevuto un evento token/risposta quando viene usato il comportamento di base di on_event_activity. Se si usa un oauth_prompt, eseguire l'override di questo metodo per inoltrare questa attività alla finestra di dialogo corrente.

async on_token_response_event(turn_context: TurnContext)

Parametri

Restituisce

Commenti

Quando il metodo on_event riceve un evento con un nome di attività token/risposta, chiama questo metodo. Se il bot usa un oauth_prompt, inoltrare l'attività in ingresso alla finestra di dialogo corrente.

Chiamato dall'adattatore (ad esempio, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) in fase di esecuzione per elaborare un Activityin ingresso.

async on_turn(turn_context: TurnContext)

Parametri

Restituisce

Commenti

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

• Aggiungere la logica da applicare prima della logica specifica del tipo e prima di chiamare on_turn.
• Aggiungere la logica da applicare dopo la logica specifica del tipo dopo aver chiamato on_turn.

Eseguire l'override di questo elemento in una classe derivata per fornire logica specifica per le attività ActivityTypes.typing, ad esempio la logica di conversazione.

async on_typing_activity(turn_context: TurnContext)

Parametri

Restituisce

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 on_turn. Se sottoposto a override, questo metodo potrebbe potenzialmente rispondere a uno qualsiasi degli altri tipi di attività.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parametri

Restituisce

Commenti

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