TeamsActivityHandler class

Pacote:

botbuilder

Adiciona suporte a eventos e interações específicos do Microsoft Teams.

Extends

ActivityHandler

Comentários

Os desenvolvedores podem lidar com as atividades de Atualização de Conversa enviadas do Microsoft Teams por meio de dois métodos:

1. Substituindo métodos começando com on.. e não terminando em ..Event() (por exemplo, onTeamsMembersAdded()), ou em vez disso
2. Passando retornos de chamada para métodos que começam com on..e terminam em ...Event() (por exemplo onTeamsMembersAddedEvent(), ), para se manter em linha com a implementação mais antiga do {@see ActivityHandler}.

Os desenvolvedores devem usar o #1 ou o nº 2, acima para todas as atividades de Atualização de Conversa e não o nº 2 e o nº 3 para a mesma atividade. Ou seja, os desenvolvedores devem substituir onTeamsMembersAdded() e não usar e onTeamsMembersAddedEvent()onTeamsMembersAdded() .

Os desenvolvedores que desejam lidar com atividades invoke devem substituir métodos começando com handle...() (por exemplo, handleTeamsTaskModuleFetch()).

Métodos

onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsChannelCreated, como para quando um canal é criado.
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsChannelDeleted, como para quando um canal é excluído.
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsChannelRenamed, como para quando um canal é renomeado.
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsChannelRestored, como para quando um canal é restaurado.
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para quando uma reunião do Teams termina.
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para quando uma reunião do Teams é iniciada.
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsMembersAdded, como para quando membros diferentes do bot ingressam no canal, como a lógica de boas-vindas do bot.
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsMembersRemoved, como quando membros diferentes do bot saem do canal, como a lógica de adeus do bot.
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para quando um Recibo de Leitura é enviado.
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamArchived, como para quando uma equipe é arquivada.
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamDeleted, como para quando uma equipe é excluída.
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamHardDeleted, como para quando uma equipe é excluída.
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamRenamed, como para quando uma equipe é renomeada.
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamRestored, como para quando uma equipe é restaurada.
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra um manipulador para eventos TeamsTeamUnarchived, como para quando uma equipe não é criada.

Métodos herdados

onCommand(BotHandler)	Registra um manipulador de eventos de atividade para a atividade de comando .
onCommandResult(BotHandler)	Registra um manipulador de eventos de atividade para a atividade CommandResult .
onConversationUpdate(BotHandler)	Registra um manipulador de eventos de atividade para o evento de atualização de conversa , emitido para cada atividade de atualização de conversa de entrada.
onDialog(BotHandler)	Registra um manipulador de eventos de atividade para o evento de caixa de diálogo , emitido como o último evento para uma atividade de entrada.
onEndOfConversation(BotHandler)	Registra um manipulador de eventos de atividade para o fim da atividade de conversa .
onEvent(BotHandler)	Registra um manipulador de eventos de atividade para o evento de evento , emitido para cada atividade de evento de entrada.
onInstallationUpdate(BotHandler)	Registra um manipulador de eventos de atividade para a atividade installationupdate .
onInstallationUpdateAdd(BotHandler)	Registra um manipulador de eventos de atividade para a atividade installationupdate add .
onInstallationUpdateRemove(BotHandler)	Registra um manipulador de eventos de atividade para a atividade installationupdate remove .
onMembersAdded(BotHandler)	Registra um manipulador de eventos de atividade para o evento adicionado aos membros , emitido para qualquer atividade de atualização de conversa de entrada que inclua membros adicionados à conversa.
onMembersRemoved(BotHandler)	Registra um manipulador de eventos de atividade para o evento de membros removidos , emitido para qualquer atividade de atualização de conversa de entrada que inclua membros removidos da conversa.
onMessage(BotHandler)	Registra um manipulador de eventos de atividade para o evento de mensagem , emitido para cada atividade de mensagem de entrada.
onMessageReaction(BotHandler)	Registra um manipulador de eventos de atividade para o evento de reação de mensagem , emitido para cada atividade de reação de mensagem de entrada.
onReactionsAdded(BotHandler)	Registra um manipulador de eventos de atividade para o evento de reações adicionadas , emitido para qualquer atividade de reação de mensagem de entrada que descreva as reações adicionadas a uma mensagem.
onReactionsRemoved(BotHandler)	Registra um manipulador de eventos de atividade para o evento reações removidas , emitido para qualquer atividade de reação de mensagem de entrada que descreva as reações removidas de uma mensagem.
onTokenResponseEvent(BotHandler)	Registra um manipulador de eventos de atividade para o evento tokens-response , emitido para qualquer atividade de evento de entrada tokens/response . Eles são gerados como parte do fluxo de autenticação OAuth.
onTurn(BotHandler)	Registra um manipulador de eventos de atividade para o evento turn , emitido para cada atividade de entrada, independentemente do tipo.
onTyping(BotHandler)	Registra um manipulador de eventos de atividade para a atividade de digitação .
onUnrecognizedActivityType(BotHandler)	Registra um manipulador de eventos de atividade para o evento de tipo de atividade não reconhecido , emitido para uma atividade de entrada com um tipo para o qual ActivityHandler não fornece um manipulador de eventos.
run(TurnContext)	Chamado para iniciar o processo de emissão de eventos.

Detalhes do método

onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsChannelCreated, como para quando um canal é criado.

function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento criado pelo canal de equipes.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsChannelDeleted, como para quando um canal é excluído.

function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento excluído do canal do Teams.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsChannelRenamed, como para quando um canal é renomeado.

function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento renomeado pelo canal do Teams.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsChannelRestored, como para quando um canal é restaurado.

function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento restaurado do canal do Teams.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para quando uma reunião do Teams termina.

function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada que manipula eventos de Fim da Reunião.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para quando uma reunião do Teams é iniciada.

function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada que manipula eventos de Início da Reunião.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsMembersAdded, como para quando membros diferentes do bot ingressam no canal, como a lógica de boas-vindas do bot.

function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento adicionado aos membros das equipes.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsMembersRemoved, como quando membros diferentes do bot saem do canal, como a lógica de adeus do bot.

function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para manipular o evento de remoção dos membros das equipes.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para quando um Recibo de Leitura é enviado.

function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada que manipula eventos de Confirmação de Leitura.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamArchived, como para quando uma equipe é arquivada.

function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento arquivado da equipe de equipe.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamDeleted, como para quando uma equipe é excluída.

function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento excluído pela equipe do teams.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamHardDeleted, como para quando uma equipe é excluída.

function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento de exclusão temporária da equipe de equipe.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamRenamed, como para quando uma equipe é renomeada.

function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento renomeado pela equipe de equipe.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamRestored, como para quando uma equipe é restaurada.

function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento restaurado pela equipe de equipe.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)

Registra um manipulador para eventos TeamsTeamUnarchived, como para quando uma equipe não é criada.

function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this

Parâmetros

handler

(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>

Um retorno de chamada para lidar com o evento não abrangente da equipe de equipe.

Retornos

this

Uma promessa que representa o trabalho enfileirado.

Detalhes do método herdado

onCommand(BotHandler)

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

function onCommand(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

Herdado de ActivityHandler.onCommand

onCommandResult(BotHandler)

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

function onCommandResult(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

Herdado de ActivityHandler.onCommandResult

onConversationUpdate(BotHandler)

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

function onConversationUpdate(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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 manipular quando os membros forem adicionados ou removidos da conversa, use os manipuladores de eventos de subtipo onMembersAdded e onMembersRemoved .

Herdado de ActivityHandler.onConversationUpdate

onDialog(BotHandler)

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

function onDialog(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Herdado de ActivityHandler.onDialog

onEndOfConversation(BotHandler)

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

function onEndOfConversation(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

Normalmente, essa atividade é enviada de uma habilidade para um chamador de habilidade indicando o fim dessa conversa filho específica.

Para lidar com um Fim da Conversa, use o manipulador de eventos específico do tipo onEndOfConversation .

Herdado de ActivityHandler.onEndOfConversation

onEvent(BotHandler)

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

function onEvent(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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 pela propriedade name da atividade, que é significativa 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 que está atualizando automaticamente um modelo de fala inserido).

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

Herdado de ActivityHandler.onEvent

onInstallationUpdate(BotHandler)

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

function onInstallationUpdate(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

Herdado de ActivityHandler.onInstallationUpdate

onInstallationUpdateAdd(BotHandler)

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

function onInstallationUpdateAdd(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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

Herdado de ActivityHandler.onInstallationUpdateAdd

onInstallationUpdateRemove(BotHandler)

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

function onInstallationUpdateRemove(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

Herdado de ActivityHandler.onInstallationUpdateRemove

onMembersAdded(BotHandler)

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

function onMembersAdded(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

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

Herdado de ActivityHandler.onMembers Adicionado

onMembersRemoved(BotHandler)

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

function onMembersRemoved(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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 manipulador de eventos específico do tipo onConversationUpdate .

Herdado de ActivityHandler.onMembersRemoved

onMessage(BotHandler)

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

function onMessage(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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.

Herdado de ActivityHandler.onMessage

onMessageReaction(BotHandler)

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

function onMessageReaction(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

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

Herdado de ActivityHandler.onMessageReaction

onReactionsAdded(BotHandler)

Registra um manipulador de eventos de atividade para o evento de reações adicionadas , 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

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

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

Herdado de ActivityHandler.onReactionsAdded

onReactionsRemoved(BotHandler)

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

function onReactionsRemoved(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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 manipulador de eventos específico do tipo onMessageReaction .

Herdado de ActivityHandler.onReactionsRemoved

onTokenResponseEvent(BotHandler)

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

function onTokenResponseEvent(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

A propriedade de valor da atividade 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 manipulador de eventos específico do tipo onEvent .

Herdado de ActivityHandler.onTokenResponseEvent

onTurn(BotHandler)

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

function onTurn(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Herdado de ActivityHandler.onTurn

onTyping(BotHandler)

Registra um manipulador de eventos de atividade para a atividade de digitação .

function onTyping(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

Uma referência ao objeto ActivityHandler .

Comentários

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

Herdado de ActivityHandler.onTyping

onUnrecognizedActivityType(BotHandler)

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

function onUnrecognizedActivityType(handler: BotHandler): this

Parâmetros

handler

BotHandler

O manipulador de eventos.

Retornos

this

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 type da atividade contém o tipo de atividade.

Herdado de ActivityHandler.onUnrecognizedActivityType

run(TurnContext)

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

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

Parâmetros

context

TurnContext

O objeto de contexto para a curva atual.

Retornos

Promise<void>

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

Herdado de ActivityHandler.run