TeamsActivityHandler class

Referencia

Paquete:: botbuilder

Agrega compatibilidad con eventos e interacciones específicos de Microsoft Teams.

Extends: ActivityHandler

Comentarios

Los desarrolladores pueden controlar las actividades de actualización de conversación enviadas desde Microsoft Teams a través de dos métodos:

Invalidar métodos que comienzan por on.. y no terminan en ..Event() (por ejemplo onTeamsMembersAdded(), ), o en su lugar
Pasar devoluciones de llamada a métodos que comienzan por on..y terminan en ...Event() (por ejemplo onTeamsMembersAddedEvent(), ), para mantenerse en línea con la implementación anterior de {@see ActivityHandler}.

Los desarrolladores deben usar #1 o #2, más arriba para todas las actividades de actualización de conversación y no para #2 y #3 para la misma actividad. Es decir, los desarrolladores deben invalidar onTeamsMembersAdded() y no usar y onTeamsMembersAdded()onTeamsMembersAddedEvent().

Los desarrolladores que quieran controlar las actividades de Invoke deben invalidar los métodos a partir handle...() de (por ejemplo, handleTeamsTaskModuleFetch()).

Métodos

onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsChannelCreated, como cuando se crea un canal.
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsChannelDeleted, como cuando se elimina un canal.
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para los eventos TeamsChannelRenamed, como cuando se cambia el nombre de un canal.
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsChannelRestored, como cuando se restaura un canal.
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para cuando finaliza una reunión de Teams.
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para cuando se inicia una reunión de Teams.
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsMembersAdded, como cuando los miembros distintos del bot se unen al canal, como la lógica de bienvenida del bot.
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para los eventos TeamsMembersRemoved, como cuando los miembros que no sean el bot abandonan el canal, como la lógica de buen bye del bot.
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para cuando se envía un recibo de lectura.
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamArchived, como cuando se archiva un equipo.
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamDeleted, como cuando se elimina un equipo.
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamHardDeleted, como cuando un equipo se elimina de forma permanente.
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamRenamed, como cuando se cambia el nombre de un equipo.
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamRestored, como cuando se restaura un equipo.
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)	Registra un controlador para eventos TeamsTeamUnarchived, como cuando un equipo no está archivado.

Métodos heredados

onCommand(BotHandler)	Registra un controlador de eventos de actividad para la actividad de comando .
onCommandResult(BotHandler)	Registra un controlador de eventos de actividad para la actividad CommandResult .
onConversationUpdate(BotHandler)	Registra un controlador de eventos de actividad para el evento de actualización de conversación , emitido para cada actividad de actualización de conversación entrante.
onDialog(BotHandler)	Registra un controlador de eventos de actividad para el evento de diálogo , emitido como el último evento de una actividad entrante.
onEndOfConversation(BotHandler)	Registra un controlador de eventos de actividad para el final de la actividad de conversación .
onEvent(BotHandler)	Registra un controlador de eventos de actividad para el evento de evento , emitido para cada actividad de evento entrante.
onInstallationUpdate(BotHandler)	Registra un controlador de eventos de actividad para la actividad installationupdate .
onInstallationUpdateAdd(BotHandler)	Registra un controlador de eventos de actividad para la actividad installationupdate add .
onInstallationUpdateRemove(BotHandler)	Registra un controlador de eventos de actividad para la actividad installationupdate remove .
onMembersAdded(BotHandler)	Registra un controlador de eventos de actividad para los miembros agregados , emitidos para cualquier actividad de actualización de conversación entrante que incluya miembros agregados a la conversación.
onMembersRemoved(BotHandler)	Registra un controlador de eventos de actividad para el evento de miembros quitados , emitido para cualquier actividad de actualización de conversación entrante que incluya miembros quitados de la conversación.
onMessage(BotHandler)	Registra un controlador de eventos de actividad para el evento de mensaje , emitido para cada actividad de mensaje entrante.
onMessageReaction(BotHandler)	Registra un controlador de eventos de actividad para el evento de reacción del mensaje , emitido para cada actividad de reacción de mensaje entrante.
onReactionsAdded(BotHandler)	Registra un controlador de eventos de actividad para las reacciones agregadas , emitido para cualquier actividad de reacción de mensaje entrante que describa las reacciones agregadas a un mensaje.
onReactionsRemoved(BotHandler)	Registra un controlador de eventos de actividad para el evento de eliminación de reacciones , emitido para cualquier actividad de reacción de mensaje entrante que describa las reacciones eliminadas de un mensaje.
onTokenResponseEvent(BotHandler)	Registra un controlador de eventos de actividad para el evento tokens-response , emitido para cualquier actividad de evento entrante `tokens/response` . Se generan como parte del flujo de autenticación de OAuth.
onTurn(BotHandler)	Registra un controlador de eventos de actividad para el evento turn , emitido para cada actividad entrante, independientemente del tipo.
onTyping(BotHandler)	Registra un controlador de eventos de actividad para la actividad de escritura .
onUnrecognizedActivityType(BotHandler)	Registra un controlador de eventos de actividad para el evento de tipo de actividad no reconocido , emitido para una actividad entrante con un tipo para el que ActivityHandler no proporciona un controlador de eventos.
run(TurnContext)	Se llama para iniciar el proceso de emisión de eventos.

Detalles del método

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

Registra un controlador para eventos TeamsChannelCreated, como cuando se crea un canal.

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>

Devolución de llamada para controlar el evento creado por el canal de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsChannelDeleted, como cuando se elimina un canal.

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>

Devolución de llamada para controlar el evento eliminado del canal de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para los eventos TeamsChannelRenamed, como cuando se cambia el nombre de un canal.

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>

Devolución de llamada para controlar el evento cuyo nombre ha cambiado el canal de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsChannelRestored, como cuando se restaura un canal.

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>

Devolución de llamada para controlar el evento restaurado del canal de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para cuando finaliza una reunión de Teams.

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>

Devolución de llamada que controla los eventos de fin de reunión.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para cuando se inicia una reunión de Teams.

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>

Devolución de llamada que controla los eventos de inicio de reunión.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsMembersAdded, como cuando los miembros distintos del bot se unen al canal, como la lógica de bienvenida del 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>

Devolución de llamada para controlar el evento agregado a los miembros de los equipos.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para los eventos TeamsMembersRemoved, como cuando los miembros que no sean el bot abandonan el canal, como la lógica de buen bye del 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>

Devolución de llamada para controlar el evento eliminado de los miembros de los equipos.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para cuando se envía un recibo de lectura.

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>

Devolución de llamada que controla los eventos read Receipt.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamArchived, como cuando se archiva un equipo.

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>

Devolución de llamada para controlar el evento archivado del equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamDeleted, como cuando se elimina un equipo.

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>

Devolución de llamada para controlar el evento eliminado por el equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamHardDeleted, como cuando un equipo se elimina de forma permanente.

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>

Devolución de llamada para controlar el evento eliminado de forma permanente del equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamRenamed, como cuando se cambia el nombre de un equipo.

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>

Devolución de llamada para controlar el evento cuyo nombre ha cambiado el equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamRestored, como cuando se restaura un equipo.

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>

Devolución de llamada para controlar el evento restaurado del equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

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

Registra un controlador para eventos TeamsTeamUnarchived, como cuando un equipo no está archivado.

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>

Devolución de llamada para controlar el evento no archivado del equipo de teams.

Devoluciones

this

Promesa que representa el trabajo en cola.

Detalles de los métodos heredados

onCommand(BotHandler)

Registra un controlador de eventos de actividad para la actividad de comando .

function onCommand(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Para controlar un evento Command, use el controlador de eventos específico del tipo onCommand .

Heredado de ActivityHandler.onCommand

onCommandResult(BotHandler)

Registra un controlador de eventos de actividad para la actividad CommandResult .

function onCommandResult(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Para controlar un evento CommandResult, use el controlador de eventos específico del tipo onCommandResult .

Heredado de ActivityHandler.onCommandResult

onConversationUpdate(BotHandler)

Registra un controlador de eventos de actividad para el evento de actualización de conversación , emitido para cada actividad de actualización de conversación entrante.

function onConversationUpdate(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Las actividades de actualización de conversación describen los cambios en los metadatos de una conversación, como título, participantes u otra información específica del canal.

Para controlar cuándo se agregan o quitan miembros de la conversación, use los controladores de eventos onMembersAdded y onMembersRemoved .

Heredado de ActivityHandler.onConversationUpdate

onDialog(BotHandler)

Registra un controlador de eventos de actividad para el evento de diálogo , emitido como el último evento de una actividad entrante.

function onDialog(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Heredado de ActivityHandler.onDialog

onEndOfConversation(BotHandler)

Registra un controlador de eventos de actividad para el final de la actividad de conversación .

function onEndOfConversation(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Normalmente, esta actividad se envía desde una aptitud a un autor de llamada de aptitud que indica el final de esa conversación secundaria determinada.

Para controlar un fin de conversación, use el controlador de eventos específico del tipo onEndOfConversation .

Heredado de ActivityHandler.onEndOfConversation

onEvent(BotHandler)

Registra un controlador de eventos de actividad para el evento de evento , emitido para cada actividad de evento entrante.

function onEvent(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Las actividades de evento transmiten información de programación de un cliente o un canal a un bot. El significado de una actividad de evento se define mediante la propiedad name de la actividad, que es significativa dentro del ámbito de un canal. Las actividades de evento están diseñadas para transportar información interactiva (por ejemplo, clics de botón) e información no interactiva (por ejemplo, una notificación de un cliente de la actualización automática de un modelo de voz insertado).

Para controlar un tokens/response evento de evento, use el controlador de eventos onTokenResponseEvent . Para controlar otros eventos con nombre, agregue lógica a este controlador.

Heredado de ActivityHandler.onEvent

onInstallationUpdate(BotHandler)

Registra un controlador de eventos de actividad para la actividad installationupdate .

function onInstallationUpdate(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Para controlar un evento InstallationUpdate, use el controlador de eventos específico del tipo onInstallationUpdate .

Heredado de ActivityHandler.onInstallationUpdate

onInstallationUpdateAdd(BotHandler)

Registra un controlador de eventos de actividad para la actividad installationupdate add .

function onInstallationUpdateAdd(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler . Para controlar un evento InstallationUpdateAdd, use el controlador de eventos específico del tipo onInstallationUpdateAdd .

Heredado de ActivityHandler.onInstallationUpdateAdd

onInstallationUpdateRemove(BotHandler)

Registra un controlador de eventos de actividad para la actividad installationupdate remove .

function onInstallationUpdateRemove(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Para controlar un evento InstallationUpdateRemove, use el controlador de eventos específico del tipo onInstallationUpdateRemove .

Heredado de ActivityHandler.onInstallationUpdateRemove

onMembersAdded(BotHandler)

Registra un controlador de eventos de actividad para los miembros agregados , emitidos para cualquier actividad de actualización de conversación entrante que incluya miembros agregados a la conversación.

function onMembersAdded(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

La propiedad membersAdded de la actividad contiene los miembros agregados a la conversación, que pueden incluir el bot.

Para controlar eventos de actualización de conversación en general, use el controlador de eventos específico del tipo onConversationUpdate .

Heredado de ActivityHandler.onMembersAdded

onMembersRemoved(BotHandler)

Registra un controlador de eventos de actividad para el evento de miembros quitados , emitido para cualquier actividad de actualización de conversación entrante que incluya miembros quitados de la conversación.

function onMembersRemoved(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

La propiedad membersRemoved de la actividad contiene los miembros quitados de la conversación, que pueden incluir el bot.

Para controlar eventos de actualización de conversación en general, use el controlador de eventos específico del tipo onConversationUpdate .

Heredado de ActivityHandler.onMembersRemoved

onMessage(BotHandler)

Registra un controlador de eventos de actividad para el evento de mensaje , emitido para cada actividad de mensaje entrante.

function onMessage(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Las actividades de mensaje representan el contenido diseñado para mostrarse dentro de una interfaz conversacional y pueden contener texto, voz, tarjetas interactivas y datos adjuntos binarios o desconocidos. No todas las actividades de mensaje contienen texto, la propiedad text de la actividad puede ser null o undefined.

Heredado de ActivityHandler.onMessage

onMessageReaction(BotHandler)

Registra un controlador de eventos de actividad para el evento de reacción del mensaje , emitido para cada actividad de reacción de mensaje entrante.

function onMessageReaction(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Las actividades de reacción de mensajes representan la interacción social en una actividad de mensajes existente de una conversación. La propiedad replyToId de la actividad de reacción del mensaje hace referencia a la actividad original. La propiedad from representa el origen de la reacción, como el usuario que ha reaccionado al mensaje.

Para controlar cuándo se agregan o quitan reacciones de los mensajes de la conversación, use los controladores de eventos onReactionsAdded y onReactionsRemoved .

Heredado de ActivityHandler.onMessageReaction

onReactionsAdded(BotHandler)

Registra un controlador de eventos de actividad para las reacciones agregadas , emitido para cualquier actividad de reacción de mensaje entrante que describa las reacciones agregadas a un mensaje.

function onReactionsAdded(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

La propiedad reacciones de la actividadAdded incluye una o varias reacciones que se agregaron.

Para controlar los eventos de reacción de mensajes en general, use el controlador de eventos específico del tipo onMessageReaction .

Heredado de ActivityHandler.onReactionsAdded

onReactionsRemoved(BotHandler)

Registra un controlador de eventos de actividad para el evento de eliminación de reacciones , emitido para cualquier actividad de reacción de mensaje entrante que describa las reacciones eliminadas de un mensaje.

function onReactionsRemoved(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

La propiedad reactionsRemoved de la actividad incluye una o varias reacciones que se eliminaron.

Para controlar los eventos de reacción de mensajes en general, use el controlador de eventos específico del tipo onMessageReaction .

Heredado de ActivityHandler.onReactionsRemoved

onTokenResponseEvent(BotHandler)

Registra un controlador de eventos de actividad para el evento tokens-response , emitido para cualquier actividad de evento entrante tokens/response . Se generan como parte del flujo de autenticación de OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

La propiedad value de la actividad contiene el token de usuario.

Si el bot controla la autenticación mediante OAuthPrompt dentro de un cuadro de diálogo, el cuadro de diálogo deberá recibir esta actividad para completar el flujo de autenticación.

Para controlar otros eventos con nombre y eventos en general, use el controlador de eventos específico del tipo onEvent .

Heredado de ActivityHandler.onTokenResponseEvent

onTurn(BotHandler)

Registra un controlador de eventos de actividad para el evento turn , emitido para cada actividad entrante, independientemente del tipo.

function onTurn(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Heredado de ActivityHandler.onTurn

onTyping(BotHandler)

Registra un controlador de eventos de actividad para la actividad de escritura .

function onTyping(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

Para controlar un evento Typing, use el controlador de eventos específico del tipo onTyping .

Heredado de ActivityHandler.onTyping

onUnrecognizedActivityType(BotHandler)

Registra un controlador de eventos de actividad para el evento de tipo de actividad no reconocido , emitido para una actividad entrante con un tipo para el que ActivityHandler no proporciona un controlador de eventos.

function onUnrecognizedActivityType(handler: BotHandler): this

Parámetros

handler: BotHandler

Controlador de eventos.

Devoluciones

this

Referencia al objeto ActivityHandler .

Comentarios

ActivityHandler No define eventos para todos los tipos de actividad definidos en el esquema de actividad de Bot Framework. Además, los canales y adaptadores personalizados pueden crear actividades con tipos que no están en el esquema. Cuando el controlador de actividad recibe este evento, emite un evento de tipo de actividad no reconocido.

La propiedad type de la actividad contiene el tipo de actividad.

Heredado de ActivityHandler.onUnrecognizedActivityType

run(TurnContext)

Se llama para iniciar el proceso de emisión de eventos.

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

Parámetros

context: TurnContext

Objeto de contexto del turno actual.

Devoluciones

Promise<void>

Comentarios

Normalmente, proporcionaría este método como controlador de funciones al que llama el adaptador para realizar la lógica del bot después de que el adaptador haya procesado previamente la actividad recibida y se enrute a través de cualquier middleware.

Por ejemplo:

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

Consulte también

BotFrameworkAdapter.processActivity

Heredado de ActivityHandler.run