ActivityHandler class

Gestore attività di creazione di eventi per i bot. Estende ActivityHandlerBase.

Extends

Commenti

Fornisce una classe estendibile per la gestione delle attività in ingresso in modo guidato dagli eventi. È possibile registrare un set arbitrario di gestori per ogni tipo di evento.

Per registrare un gestore per un evento, usare il corrispondente nel metodo di evento. Se più gestori vengono registrati per un evento, vengono eseguiti nell'ordine in cui sono stati registrati.

Questo oggetto genera una serie di eventi durante l'elaborazione di un'attività in ingresso. Un gestore può arrestare la propagazione dell'evento non chiamando la funzione di continuazione.

Tipo di evento Descrizione
Girare Generato per primo per ogni attività.
Specifico del tipo Generato per il tipo di attività specifico, prima di generare un evento per qualsiasi sottotipo.
Sottotipo Generato per determinati eventi specializzati, in base al contenuto dell'attività.
Dialogo Generato come evento di elaborazione dell'attività finale.

Per esempio:

const bot = new ActivityHandler();

server.post('/api/messages', (req, res) => {
    adapter.processActivity(req, res, async (context) => {
        // Route to bot's activity logic.
        await bot.run(context);
    });
});

bot.onTurn(async (context, next) => {
        // Handle a "turn" event.
        await context.sendActivity(`${ context.activity.type } activity received.`);
        // Continue with further processing.
        await next();
    })
    .onMessage(async (context, next) => {
        // Handle a message activity.
        await context.sendActivity(`Echo: ${ context.activity.text }`);
        // Continue with further processing.
        await next();
    });

Vedere anche

Metodi

onCommand(BotHandler)

Registra un gestore eventi attività per l'attività comando.

onCommandResult(BotHandler)

Registra un gestore eventi attività per l'attività CommandResult.

onConversationUpdate(BotHandler)

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

onDialog(BotHandler)

Registra un gestore eventi di attività per la finestra di dialogo evento, generato come ultimo evento per un'attività in ingresso.

onEndOfConversation(BotHandler)

Registra un gestore eventi di attività per la fine della conversazione 'attività di.

onEvent(BotHandler)

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

onInstallationUpdate(BotHandler)

Registra un gestore eventi attività per l'attività installationupdate.

onInstallationUpdateAdd(BotHandler)

Registra un gestore eventi di attività per l''attività add.

onInstallationUpdateRemove(BotHandler)

Registra un gestore eventi di attività per l''operazione di rimozione'attività.

onMembersAdded(BotHandler)

Registra un gestore eventi di attività per i membri aggiunti evento, generato per qualsiasi attività di aggiornamento della conversazione in ingresso che include membri aggiunti alla conversazione.

onMembersRemoved(BotHandler)

Registra un gestore eventi di attività per i membri rimossi evento, generato per qualsiasi attività di aggiornamento della conversazione in ingresso che include i membri rimossi dalla conversazione.

onMessage(BotHandler)

Registra un gestore eventi di attività per l'evento messaggio, generato per ogni attività del messaggio in arrivo.

onMessageReaction(BotHandler)

Registra un gestore eventi di attività per la reazione messaggio evento, generato per ogni attività di reazione al messaggio in arrivo.

onReactionsAdded(BotHandler)

Registra un gestore eventi di attività per le reazioni aggiunte evento, generato per qualsiasi attività di reazione al messaggio in arrivo che descrive le reazioni aggiunte a un messaggio.

onReactionsRemoved(BotHandler)

Registra un gestore eventi di attività per le reazioni rimosse evento, generato per qualsiasi attività di reazione al messaggio in arrivo che descrive le reazioni rimosse da un messaggio.

onTokenResponseEvent(BotHandler)

Registra un gestore eventi di attività per l'evento token di risposta token , generato per qualsiasi attività di evento in ingresso. Questi vengono generati come parte del flusso di autenticazione OAuth.

onTurn(BotHandler)

Registra un gestore eventi attività per l'evento di turno, generato per ogni attività in ingresso, indipendentemente dal tipo.

onTyping(BotHandler)

Registra un gestore eventi attività per l'attività digitando attività.

onUnrecognizedActivityType(BotHandler)

Registra un gestore eventi di attività per il tipo di attività non riconosciuto evento, generato per un'attività in ingresso con un tipo per cui il ActivityHandler non fornisce un gestore eventi.

run(TurnContext)

Chiamato per avviare il processo di emissione dell'evento.

Dettagli metodo

onCommand(BotHandler)

Registra un gestore eventi attività per l'attività comando.

function onCommand(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Per gestire un evento Command, usare il onCommand gestore eventi specifico del tipo.

onCommandResult(BotHandler)

Registra un gestore eventi attività per l'attività CommandResult.

function onCommandResult(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Per gestire un evento CommandResult, usare il onCommandResult gestore eventi specifico del tipo.

onConversationUpdate(BotHandler)

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

function onConversationUpdate(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le attività di aggiornamento della conversazione descrivono le modifiche apportate ai metadati di una conversazione, ad esempio titolo, partecipanti o altre informazioni specifiche del canale.

Per gestire quando i membri vengono aggiunti o rimossi dalla conversazione, usare il onMembersAdded e onMembersRemoved gestori eventi di sottotipo.

onDialog(BotHandler)

Registra un gestore eventi di attività per la finestra di dialogo evento, generato come ultimo evento per un'attività in ingresso.

function onDialog(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

onEndOfConversation(BotHandler)

Registra un gestore eventi di attività per la fine della conversazione 'attività di.

function onEndOfConversation(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Questa attività viene in genere inviata da una competenza a un chiamante competenza che indica la fine di tale conversazione figlio specifica.

Per gestire una conversazione finale, usare il onEndOfConversation gestore eventi specifico del tipo.

onEvent(BotHandler)

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

function onEvent(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le attività evento comunicano informazioni a livello di codice da un client o da un canale a un bot. Il significato di un'attività di evento è definito dal nome proprietà dell'attività, che è significativo nell'ambito di un canale. Le attività di evento sono progettate per includere informazioni interattive (ad esempio clic sul pulsante) e informazioni non interattive (ad esempio una notifica di un client che aggiorna automaticamente un modello di riconoscimento vocale incorporato).

Per gestire un evento di tokens/response, usare il onTokenResponseEvent gestore eventi di sottotipo. Per gestire altri eventi denominati, aggiungere logica a questo gestore.

onInstallationUpdate(BotHandler)

Registra un gestore eventi attività per l'attività installationupdate.

function onInstallationUpdate(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Per gestire un evento InstallationUpdate, usare il onInstallationUpdate gestore eventi specifico del tipo.

onInstallationUpdateAdd(BotHandler)

Registra un gestore eventi di attività per l''attività add.

function onInstallationUpdateAdd(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler . Per gestire un evento InstallationUpdateAdd, usare il onInstallationUpdateAdd gestore eventi specifico del tipo.

onInstallationUpdateRemove(BotHandler)

Registra un gestore eventi di attività per l''operazione di rimozione'attività.

function onInstallationUpdateRemove(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Per gestire un evento InstallationUpdateRemove, usare il onInstallationUpdateRemove gestore eventi specifico del tipo.

onMembersAdded(BotHandler)

Registra un gestore eventi di attività per i membri aggiunti evento, generato per qualsiasi attività di aggiornamento della conversazione in ingresso che include membri aggiunti alla conversazione.

function onMembersAdded(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

La proprietà dell'attivitàAggiungi contiene i membri aggiunti alla conversazione, che possono includere il bot.

Per gestire gli eventi di aggiornamento della conversazione in generale, usare il onConversationUpdate gestore eventi specifico del tipo.

onMembersRemoved(BotHandler)

Registra un gestore eventi di attività per i membri rimossi evento, generato per qualsiasi attività di aggiornamento della conversazione in ingresso che include i membri rimossi dalla conversazione.

function onMembersRemoved(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

La proprietà membri dell'attivitàRemoved contiene i membri rimossi dalla conversazione, che possono includere il bot.

Per gestire gli eventi di aggiornamento della conversazione in generale, usare il onConversationUpdate gestore eventi specifico del tipo.

onMessage(BotHandler)

Registra un gestore eventi di attività per l'evento messaggio, generato per ogni attività del messaggio in arrivo.

function onMessage(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le attività di messaggio rappresentano il contenuto che deve essere visualizzato all'interno di un'interfaccia di conversazione e può contenere testo, riconoscimento vocale, schede interattive e allegati binari o sconosciuti. Non tutte le attività del messaggio contengono testo, la proprietà testo dell'attività può essere null o undefined.

onMessageReaction(BotHandler)

Registra un gestore eventi di attività per la reazione messaggio evento, generato per ogni attività di reazione al messaggio in arrivo.

function onMessageReaction(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le attività di reazione ai messaggi rappresentano un'interazione sociale su un'attività di messaggio esistente all'interno di una conversazione. L'attività originale viene indicata dalla proprietà replyTo Id dell'attività di reazione del messaggio. Il dalla proprietà rappresenta l'origine della reazione, ad esempio l'utente che ha reagito al messaggio.

Per gestire quando le reazioni vengono aggiunte o rimosse dai messaggi nella conversazione, usare il onReactionsAdded e onReactionsRemoved gestori eventi di sottotipo.

onReactionsAdded(BotHandler)

Registra un gestore eventi di attività per le reazioni aggiunte evento, generato per qualsiasi attività di reazione al messaggio in arrivo che descrive le reazioni aggiunte a un messaggio.

function onReactionsAdded(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le reazioni dell'attivitàAggiungi proprietà includono una o più reazioni aggiunte.

Per gestire gli eventi di reazione ai messaggi in generale, usare il onMessageReaction gestore eventi specifico del tipo.

onReactionsRemoved(BotHandler)

Registra un gestore eventi di attività per le reazioni rimosse evento, generato per qualsiasi attività di reazione al messaggio in arrivo che descrive le reazioni rimosse da un messaggio.

function onReactionsRemoved(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Le reazioni dell'attivitàRemoved proprietà includono una o più reazioni rimosse.

Per gestire gli eventi di reazione ai messaggi in generale, usare il onMessageReaction gestore eventi specifico del tipo.

onTokenResponseEvent(BotHandler)

Registra un gestore eventi di attività per l'evento token di risposta token , generato per qualsiasi attività di evento in ingresso. Questi vengono generati come parte del flusso di autenticazione OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Il valore dell'attività proprietà contiene il token utente.

Se il bot gestisce l'autenticazione usando un OAuthPrompt all'interno di una finestra di dialogo, la finestra di dialogo dovrà ricevere questa attività per completare il flusso di autenticazione.

Per gestire in generale altri eventi denominati ed eventi evento, usare il onEvent gestore eventi specifico del tipo.

onTurn(BotHandler)

Registra un gestore eventi attività per l'evento di turno, generato per ogni attività in ingresso, indipendentemente dal tipo.

function onTurn(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

onTyping(BotHandler)

Registra un gestore eventi attività per l'attività digitando attività.

function onTyping(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Per gestire un evento Typing, utilizzare il onTyping gestore eventi specifico del tipo.

onUnrecognizedActivityType(BotHandler)

Registra un gestore eventi di attività per il tipo di attività non riconosciuto evento, generato per un'attività in ingresso con un tipo per cui il ActivityHandler non fornisce un gestore eventi.

function onUnrecognizedActivityType(handler: BotHandler): this

Parametri

handler
BotHandler

Gestore eventi.

Restituisce

this

Riferimento all'oggetto ActivityHandler .

Commenti

Il ActivityHandler non definisce eventi per tutti i tipi di attività definiti nello schema dell'attività di Bot Framework . Inoltre, i canali e gli adattatori personalizzati possono creare Attività con tipi non inclusi nello schema. Quando il gestore attività riceve un evento di questo tipo, genera un evento di tipo di attività non riconosciuto.

Il tipo di dell'attività proprietà contiene il tipo di attività.

run(TurnContext)

Chiamato per avviare il processo di emissione dell'evento.

function run(context: TurnContext): Promise<void>

Parametri

context
TurnContext

Oggetto di contesto per il turno corrente.

Restituisce

Promise<void>

Commenti

In genere, questo metodo viene fornito come gestore di funzioni che l'adapter chiama per eseguire la logica del bot dopo che l'attività ricevuta è stata pre-elaborata dall'adapter e indirizzata attraverso qualsiasi middleware.

Per esempio:

 server.post('/api/messages', (req, res) => {
     adapter.processActivity(req, res, async (context) => {
         // Route to bot's activity logic.
         await bot.run(context);
     });
});

Vedere anche

  • BotFrameworkAdapter.processActivity