ActivityHandler class

Registra um manipulador de eventos de atividade para a atividade do comando.

function onCommand(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Para manipular um evento Command, use o onCommand manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para a atividade CommandResult.

function onCommandResult(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Para manipular um evento CommandResult, use o onCommandResult manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para a atualização de conversa evento, emitido para cada atividade de atualização de conversa de entrada.

function onConversationUpdate(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

As atividades de atualização de conversa descrevem as alterações nos metadados de uma conversa, como título, participantes ou outras informações específicas do canal.

Para lidar quando os membros são adicionados ou removidos da conversa, use os onMembersAdded e onMembersRemoved manipuladores de eventos de subtipo.

Registra um manipulador de eventos de atividade para a caixa de diálogo evento, emitido como o último evento para uma atividade de entrada.

function onDialog(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Registra um manipulador de eventos de atividade para a atividade de fim da conversa.

function onEndOfConversation(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Essa atividade normalmente é enviada de uma habilidade para um chamador de habilidade que indica o fim dessa conversa filho em particular.

Para lidar com um fim de conversa, use o onEndOfConversation manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para o evento evento, emitido para cada atividade de evento de entrada.

function onEvent(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

As atividades de evento comunicam informações programáticas de um cliente ou canal para um bot. O significado de uma atividade de evento é definido pelo nome da atividade propriedade, o que é significativo dentro do escopo de um canal. As atividades de evento são projetadas para transportar informações interativas (como cliques de botão) e informações não interativas (como uma notificação de um cliente atualizando automaticamente um modelo de fala inserido).

Para lidar com um evento de tokens/response, use o manipulador de eventos onTokenResponseEvent subtipo. Para lidar com outros eventos nomeados, adicione lógica a esse manipulador.

Registra um manipulador de eventos de atividade para a atividade installationupdate.

function onInstallationUpdate(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Para manipular um evento InstallationUpdate, use o manipulador de eventos onInstallationUpdate tipo específico.

Registra um manipulador de eventos de atividade para o atividade add de instalação.

function onInstallationUpdateAdd(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler. Para manipular um evento InstallationUpdateAdd, use o onInstallationUpdateAdd manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para o instalaçãoupdate remover atividade.

function onInstallationUpdateRemove(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Para manipular um evento InstallationUpdateRemove, use o onInstallationUpdateRemove manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para os membros adicionados evento, emitido para qualquer atividade de atualização de conversa de entrada que inclua membros adicionados à conversa.

function onMembersAdded(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

A propriedade membros adicionados da atividade contém os membros adicionados à conversa, o que pode incluir o bot.

Para lidar com eventos de atualização de conversa em geral, use o onConversationUpdate manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para os membros removidos evento, emitido para qualquer atividade de atualização de conversa de entrada que inclua membros removidos da conversa.

function onMembersRemoved(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

A propriedade membersRemoved da atividade contém os membros removidos da conversa, o que pode incluir o bot.

Para lidar com eventos de atualização de conversa em geral, use o onConversationUpdate manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para a mensagem evento, emitido para cada atividade de mensagem de entrada.

function onMessage(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

As atividades de mensagem representam o conteúdo destinado a ser mostrado em uma interface de conversa e podem conter texto, fala, cartões interativos e anexos binários ou desconhecidos. Nem todas as atividades de mensagem contêm texto, a propriedade de texto da atividade pode ser null ou undefined.

Registra um manipulador de eventos de atividade para a reação da mensagem evento, emitido para cada atividade de reação de mensagem de entrada.

function onMessageReaction(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

As atividades de reação de mensagem representam uma interação social em uma atividade de mensagem existente dentro de uma conversa. A atividade original é referida pela propriedade de replyToId da atividade de reação da mensagem. O da propriedade representa a origem da reação, como o usuário que reagiu à mensagem.

Para lidar quando as reações são adicionadas ou removidas de mensagens na conversa, use o onReactionsAdded e onReactionsRemoved manipuladores de eventos de subtipo.

Registra um manipulador de eventos de atividade para as reações adicionadas evento, emitido para qualquer atividade de reação de mensagem de entrada que descreva as reações adicionadas a uma mensagem.

function onReactionsAdded(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Reações da atividade Adicionadas propriedade inclui uma ou mais reações que foram adicionadas.

Para lidar com eventos de reação de mensagem em geral, use o onMessageReaction manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para as reações removidas evento, emitido para qualquer atividade de reação de mensagem de entrada que descreve as reações removidas de uma mensagem.

function onReactionsRemoved(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

A propriedade reactionsRemoved da atividade inclui uma ou mais reações que foram removidas.

Para lidar com eventos de reação de mensagem em geral, use o onMessageReaction manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para o evento tokens-resposta, emitido para qualquer atividade de evento de tokens/response de entrada. Eles são gerados como parte do fluxo de autenticação OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

O valor da atividade propriedade contém o token de usuário.

Se o bot manipular a autenticação usando um OAuthPrompt em uma caixa de diálogo, a caixa de diálogo precisará receber essa atividade para concluir o fluxo de autenticação.

Para lidar com outros eventos nomeados e eventos de evento em geral, use o onEvent manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para o evento, emitido para cada atividade de entrada, independentemente do tipo.

function onTurn(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Registra um manipulador de eventos de atividade para o digitando atividade.

function onTyping(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

Para lidar com um evento de digitação, use o onTyping manipulador de eventos específico do tipo.

Registra um manipulador de eventos de atividade para o tipo de atividade não reconhecido evento, emitido para uma atividade de entrada com um tipo para o qual o ActivityHandler não fornece um manipulador de eventos.

function onUnrecognizedActivityType(handler: BotHandler): this

Parâmetros

Retornos

Uma referência ao objeto ActivityHandler.

Comentários

O ActivityHandler não define eventos para todos os tipos de atividade definidos no esquema de atividade do Bot Framework. Além disso, canais e adaptadores personalizados podem criar Atividades com tipos que não estão no esquema. Quando o manipulador de atividade recebe esse evento, ele emite um evento de tipo de atividade não reconhecido.

A propriedade do tipo da atividade contém o tipo de atividade.

Chamado para iniciar o processo de emissão de eventos.

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

Parâmetros

Retornos

Comentários

Normalmente, você forneceria esse método como o manipulador de funções que o adaptador chama para executar a lógica do bot depois que a atividade recebida tiver sido pré-processada pelo adaptador e roteada por meio de qualquer middleware.

Por exemplo:

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

Consulte também

• BotFrameworkAdapter.processActivity