TeamsActivityHandler class
A handler for processing Microsoft Teams-specific activities. Extends the ActivityHandler class to provide additional Teams-specific functionality. This class includes methods for handling various Teams events, such as message updates, channel events, and meeting events.
- Extends
Methods
Inherited Methods
| on |
Registers a handler for the ConversationUpdate activity type. This is called when the conversation is updated, such as when members are added or removed. |
| on |
Registers an activity event handler for the dialog event, emitted as the last event for an incoming activity. This handler is called after all other handlers have been processed. |
| on |
Registers a handler for the EndOfConversation activity type. This is called when the conversation ends. |
| on |
Registers a handler for the InstallationUpdate activity type. This is called when an agent is installed or uninstalled. |
| on |
Registers a handler for the InstallationUpdateAdd activity type. This is called when an agent is installed or upgraded. |
| on |
Registers a handler for the InstallationUpdateRemove activity type. This is called when an agent is uninstalled or downgraded. |
| on |
Registers a handler for the MembersAdded activity type. This is called when new members are added to the conversation. |
| on |
Registers a handler for the MembersRemoved activity type. This is called when members are removed from the conversation. |
| on |
Registers a handler for the Message activity type. This is called when a message is received from the user. |
| on |
Registers a handler for the MessageDelete activity type. This is called when a message is deleted. |
| on |
Registers a handler for the MessageReaction activity type. This is called when reactions are added or removed from messages. |
| on |
Registers a handler for the MessageUpdate activity type. This is called when a message is updated. |
| on |
Registers a handler for the ReactionsAdded activity type. This is called when reactions are added to messages. |
| on |
Registers a handler for the ReactionsRemoved activity type. This is called when reactions are removed from messages. |
| on |
Registers a handler for the SignInInvoke activity type. This is called when a sign-in is requested. |
| on |
Registers a handler for the Turn activity type. This is called for all activities regardless of type. |
| on |
Registers a handler for the Typing activity type. This is called when a typing indicator is received. |
| on |
Registers a handler for unrecognized activity types. This is called when an activity type is not recognized. |
| run(Turn |
Runs the activity handler pipeline. This method is called to process an incoming activity through the registered handlers. |
Method Details
onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams channel created event.
function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams channel deleted event.
function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams channel renamed event.
function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams channel restored event.
function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams meeting end event.
function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMeetingParticipantsJoinEvent((meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams meeting participants join event.
function onTeamsMeetingParticipantsJoinEvent(handler: (meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMeetingParticipantsLeaveEvent((meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams meeting participants leave event.
function onTeamsMeetingParticipantsLeaveEvent(handler: (meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(meeting: MeetingParticipantsEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams meeting start event.
function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams members added event.
function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams members removed event.
function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMessageEditEvent((context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams message edit event.
function onTeamsMessageEditEvent(handler: (context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMessageSoftDeleteEvent((context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams message soft delete event.
function onTeamsMessageSoftDeleteEvent(handler: (context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsMessageUndeleteEvent((context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams message undelete event.
function onTeamsMessageUndeleteEvent(handler: (context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams read receipt event.
function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team archived event.
function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team deleted event.
function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team hard deleted event.
function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team renamed event.
function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team restored event.
function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Registers a handler for Teams team unarchived event.
function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): TeamsActivityHandlerParameters
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
The handler function.
Returns
Inherited Method Details
onConversationUpdate(AgentHandler)
Registers a handler for the ConversationUpdate activity type. This is called when the conversation is updated, such as when members are added or removed.
function onConversationUpdate(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onConversationUpdate
onDialog(AgentHandler)
Registers an activity event handler for the dialog event, emitted as the last event for an incoming activity. This handler is called after all other handlers have been processed.
function onDialog(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onDialog
onEndOfConversation(AgentHandler)
Registers a handler for the EndOfConversation activity type. This is called when the conversation ends.
function onEndOfConversation(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onEndOfConversation
onInstallationUpdate(AgentHandler)
Registers a handler for the InstallationUpdate activity type. This is called when an agent is installed or uninstalled.
function onInstallationUpdate(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onInstallationUpdate
onInstallationUpdateAdd(AgentHandler)
Registers a handler for the InstallationUpdateAdd activity type. This is called when an agent is installed or upgraded.
function onInstallationUpdateAdd(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onInstallationUpdateAdd
onInstallationUpdateRemove(AgentHandler)
Registers a handler for the InstallationUpdateRemove activity type. This is called when an agent is uninstalled or downgraded.
function onInstallationUpdateRemove(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onInstallationUpdateRemove
onMembersAdded(AgentHandler)
Registers a handler for the MembersAdded activity type. This is called when new members are added to the conversation.
function onMembersAdded(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMembersAdded
onMembersRemoved(AgentHandler)
Registers a handler for the MembersRemoved activity type. This is called when members are removed from the conversation.
function onMembersRemoved(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMembersRemoved
onMessage(AgentHandler)
Registers a handler for the Message activity type. This is called when a message is received from the user.
function onMessage(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMessage
onMessageDelete(AgentHandler)
Registers a handler for the MessageDelete activity type. This is called when a message is deleted.
function onMessageDelete(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMessageDelete
onMessageReaction(AgentHandler)
Registers a handler for the MessageReaction activity type. This is called when reactions are added or removed from messages.
function onMessageReaction(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMessageReaction
onMessageUpdate(AgentHandler)
Registers a handler for the MessageUpdate activity type. This is called when a message is updated.
function onMessageUpdate(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onMessageUpdate
onReactionsAdded(AgentHandler)
Registers a handler for the ReactionsAdded activity type. This is called when reactions are added to messages.
function onReactionsAdded(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onReactionsAdded
onReactionsRemoved(AgentHandler)
Registers a handler for the ReactionsRemoved activity type. This is called when reactions are removed from messages.
function onReactionsRemoved(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onReactionsRemoved
onSignInInvoke(AgentHandler)
Registers a handler for the SignInInvoke activity type. This is called when a sign-in is requested.
function onSignInInvoke(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onSignInInvoke
onTurn(AgentHandler)
Registers a handler for the Turn activity type. This is called for all activities regardless of type.
function onTurn(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onTurn
onTyping(AgentHandler)
Registers a handler for the Typing activity type. This is called when a typing indicator is received.
function onTyping(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onTyping
onUnrecognizedActivityType(AgentHandler)
Registers a handler for unrecognized activity types. This is called when an activity type is not recognized.
function onUnrecognizedActivityType(handler: AgentHandler): TeamsActivityHandlerParameters
- handler
- AgentHandler
The handler to register
Returns
The current instance for method chaining
Inherited From ActivityHandler.onUnrecognizedActivityType
run(TurnContext)
Runs the activity handler pipeline. This method is called to process an incoming activity through the registered handlers.
function run(context: TurnContext): Promise<void>Parameters
- context
- TurnContext
The turn context for the current turn of conversation
Returns
Promise<void>
Inherited From ActivityHandler.run