TeamsActivityHandler class
Добавляет поддержку конкретных событий и взаимодействий Microsoft Teams.
- Extends
-
ActivityHandler
Комментарии
Разработчики могут обрабатывать действия обновления бесед, отправляемые из Microsoft Teams, двумя способами:
- Переопределение методов, начиная с
on..
и не заканчивается..Event()
(например,onTeamsMembersAdded()
) или вместо этого - Передача обратных вызовов методам, начиная с
on..
и в конце...Event()
(например,onTeamsMembersAddedEvent()
), чтобы оставаться в соответствии со старой реализацией {@see ActivityHandler}.
Разработчики должны использовать #1 или #2, прежде всего для всех действий обновления бесед, а не как #2, так и #3 для одного действия. Это означает, что разработчики должны переопределить onTeamsMembersAdded()
и не использовать как onTeamsMembersAdded()
, так и onTeamsMembersAddedEvent()
.
Разработчики, желающие обрабатывать действия Invoke, должны переопределять методы, начиная с handle...()
(например, handleTeamsTaskModuleFetch()
).
Методы
Наследуемые методы
on |
Регистрирует обработчик событий действия для команды действия. |
on |
Регистрирует обработчик событий действия для действия CommandResult. |
on |
Регистрирует обработчик событий действия для события обновления беседы события, выдаваемого для каждого входящего действия обновления беседы. |
on |
Регистрирует обработчик событий действия для диалогового окна |
on |
Регистрирует обработчик событий действия для конца беседы действия. |
on |
Регистрирует обработчик событий действия для события события, генерируемого для каждого входящего события. |
on |
Регистрирует обработчик событий действия для действия установки. |
on |
Регистрирует обработчик событий действия для установки добавления действия. |
on |
Регистрирует обработчик событий действия для установки удаления действия. |
on |
Регистрирует обработчик событий действия для участников добавленных событий, создаваемых для любого входящего действия обновления беседы, включающего участников, добавленных в беседу. |
on |
Регистрирует обработчик событий действия для участников удаленных события, выдаваемого для всех входящих действий обновления беседы, включающих участников, удаленных из беседы. |
on |
Регистрирует обработчик событий действия для события сообщения, выдаваемого для каждого входящего действия сообщения. |
on |
Регистрирует обработчик событий действия для события реакции сообщения события, генерируемого для каждого входящего действия реакции сообщения. |
on |
Регистрирует обработчик событий активности для реакций, добавленных событием, созданным для любого входящего действия реакции сообщения, описывающего реакции, добавленные в сообщение. |
on |
Регистрирует обработчик событий действия для реакций, удаленных события, выдаваемого для любого действия реакции входящего сообщения, описывающего реакции, удаленные из сообщения. |
on |
Регистрирует обработчик событий действия для события токенов-ответов, создаваемых для любого входящего действия события |
on |
Регистрирует обработчик событий действия для события, создаваемого для каждого входящего действия независимо от типа. |
on |
Регистрирует обработчик событий действия для действия ввода действия. |
on |
Регистрирует обработчик событий действия для нераспознанного типа действия события, создаваемого для входящего действия с типом, для которого ActivityHandler не предоставляет обработчик событий. |
run(Turn |
Вызывается для запуска процесса выбросов событий. |
Сведения о методе
onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик событий TeamsChannelCreated, например при создании канала.
function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки созданного канала teams.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик событий TeamsChannelDeleted, например при удалении канала.
function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки удаленного события канала teams.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsChannelRenamed, например при переименовании канала.
function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки переименованного события канала teams.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsChannelRestored, например при восстановлении канала.
function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки восстановленного события канала teams.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик при завершении собрания Teams.
function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов, обрабатывающий события окончания собрания.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик при запуске собрания Teams.
function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов, обрабатывающий события начала собрания.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик событий TeamsMembersAdded, например, когда участники, отличные от бота, присоединяются к каналу, например логика приветствия бота.
function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки добавленного события участниками команд.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsMembersRemoved, например, когда члены, отличные от бота, покидают канал, например логику хорошей работы бота.
function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки удаленных участников команд.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик при отправке квитанции чтения.
function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов, обрабатывающий события получения сведений.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamArchived, например, когда команда архивируется.
function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки архивированного события команды.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamDeleted, например при удалении команды.
function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки события удаления команды.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamHardDeleted, например при жестком удалении команды.
function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки события, удаленного командой.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamRenamed, например при переименовании команды.
function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки события, переименованного командой команды.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamRestored, например при восстановлении команды.
function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки события восстановления команды.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>)
Регистрирует обработчик для событий TeamsTeamUnarchived, например при отмене иерархии команды.
function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>): this
Параметры
- handler
-
(teamInfo: TeamInfo, context: TurnContext, next: () => Promise<void>) => Promise<void>
Обратный вызов для обработки неархивированного события команды.
Возвращаемое значение
this
Обещание, представляющее рабочие очереди.
Сведения о наследуемом методе
onCommand(BotHandler)
Регистрирует обработчик событий действия для команды действия.
function onCommand(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Чтобы обработать событие command, используйте обработчик событий onCommand для конкретного типа.
наследуется от ActivityHandler.onCommand
onCommandResult(BotHandler)
Регистрирует обработчик событий действия для действия CommandResult.
function onCommandResult(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Для обработки события CommandResult используйте обработчик событий onCommandResult типа.
наследуется от ActivityHandler.onCommandResult
onConversationUpdate(BotHandler)
Регистрирует обработчик событий действия для события обновления беседы события, выдаваемого для каждого входящего действия обновления беседы.
function onConversationUpdate(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Действия обновления беседы описывают изменения метаданных беседы, таких как название, участники или другие сведения о канале.
Для обработки при добавлении или удалении элементов из беседы используйте onMembersAdded и onMembersRemoved обработчики событий подтипа.
наследуется от ActivityHandler.onConversationUpdate
onDialog(BotHandler)
Регистрирует обработчик событий действия для диалогового окна
function onDialog(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
наследуется от ActivityHandler.onDialog
onEndOfConversation(BotHandler)
Регистрирует обработчик событий действия для конца беседы действия.
function onEndOfConversation(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Обычно это действие отправляется из навыка в вызывающий объект Навыка, указывающий конец конкретного дочернего диалога.
Для обработки завершения беседы используйте обработчик событий onEndOfConversation типа.
наследуется от ActivityHandler.onEndOfConversation
onEvent(BotHandler)
Регистрирует обработчик событий действия для события события, генерируемого для каждого входящего события.
function onEvent(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Действия событий передают программные сведения от клиента или канала боту. Значение действия события определяется именем действия свойством, которое имеет смысл в области канала. Действия событий предназначены для передачи интерактивных сведений (таких как нажатия кнопки) и неинтерактивной информации (например, уведомления клиента автоматически обновляют внедренную модель речи).
Для обработки события tokens/response
используйте обработчик событий onTokenResponseEvent обработчик событий подтипа. Чтобы обрабатывать другие именованные события, добавьте логику в этот обработчик.
наследуется от ActivityHandler.onEvent
onInstallationUpdate(BotHandler)
Регистрирует обработчик событий действия для действия установки.
function onInstallationUpdate(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Чтобы обработать событие InstallationUpdate, используйте обработчик событий onInstallationUpdate определенного типа.
наследуется от ActivityHandler.onInstallationUpdate
onInstallationUpdateAdd(BotHandler)
Регистрирует обработчик событий действия для установки добавления действия.
function onInstallationUpdateAdd(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
наследуется от ActivityHandler.onInstallationUpdateAddd
onInstallationUpdateRemove(BotHandler)
Регистрирует обработчик событий действия для установки удаления действия.
function onInstallationUpdateRemove(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Чтобы обработать событие InstallationUpdateRemove, используйте обработчик событий onInstallationUpdateRemove типа.
наследуется от ActivityHandler.onInstallationUpdateRemove
onMembersAdded(BotHandler)
Регистрирует обработчик событий действия для участников добавленных событий, создаваемых для любого входящего действия обновления беседы, включающего участников, добавленных в беседу.
function onMembersAdded(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Свойство участников действияAdded содержит элементы, добавленные в беседу, которые могут включать бота.
Для обработки событий обновления беседы в целом используйте обработчик событий onConversationUpdate для конкретного типа.
наследуется от ActivityHandler.onMembersAdded
onMembersRemoved(BotHandler)
Регистрирует обработчик событий действия для участников удаленных события, выдаваемого для всех входящих действий обновления беседы, включающих участников, удаленных из беседы.
function onMembersRemoved(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Свойство "" действия "Удалено" содержит элементы, удаленные из беседы, которые могут включать бота.
Для обработки событий обновления беседы в целом используйте обработчик событий onConversationUpdate для конкретного типа.
наследуется от ActivityHandler.onMembersRemoved
onMessage(BotHandler)
Регистрирует обработчик событий действия для события сообщения, выдаваемого для каждого входящего действия сообщения.
function onMessage(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Действия сообщения представляют содержимое, которое должно отображаться в диалоговом интерфейсе и может содержать текст, речь, интерактивные карточки и двоичные или неизвестные вложения.
Не все действия сообщения содержат текст, свойство текста действия может быть null
или undefined
.
наследуется от ActivityHandler.onMessage
onMessageReaction(BotHandler)
Регистрирует обработчик событий действия для события реакции сообщения события, генерируемого для каждого входящего действия реакции сообщения.
function onMessageReaction(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Действия реакции сообщения представляют социальное взаимодействие с существующим действием сообщения в беседе. Исходное действие ссылается на свойство ответа на ответную действия сообщения. из свойства представляет источник реакции, например пользователь, реагирующий на сообщение.
Для обработки при добавлении или удалении реакций из сообщений в беседе используйте onReactionsAdded и onReactionsRemoved обработчики событий подтипа.
наследуется от ActivityHandler.onMessageReaction
onReactionsAdded(BotHandler)
Регистрирует обработчик событий активности для реакций, добавленных событием, созданным для любого входящего действия реакции сообщения, описывающего реакции, добавленные в сообщение.
function onReactionsAdded(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Свойство реакции действияAdded включает одну или несколько реакций, которые были добавлены.
Для обработки событий реакции сообщения в целом используйте обработчик событий onMessageReaction обработчик событий, зависящих от типа.
наследуется от ActivityHandler.onReactionsAdded
onReactionsRemoved(BotHandler)
Регистрирует обработчик событий действия для реакций, удаленных события, выдаваемого для любого действия реакции входящего сообщения, описывающего реакции, удаленные из сообщения.
function onReactionsRemoved(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
реакции действия удалены свойство включает одну или несколько реакций, которые были удалены.
Для обработки событий реакции сообщения в целом используйте обработчик событий onMessageReaction обработчик событий, зависящих от типа.
наследуется от ActivityHandler.onReactionsRemoved
onTokenResponseEvent(BotHandler)
Регистрирует обработчик событий действия для события токенов-ответов, создаваемых для любого входящего действия события tokens/response
. Они создаются в рамках потока проверки подлинности OAuth.
function onTokenResponseEvent(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Значение действия содержит маркер пользователя.
Если бот обрабатывает проверку подлинности с помощью OAuthPrompt в диалоговом окне, то для завершения потока проверки подлинности необходимо будет получить это действие.
Для обработки других именованных событий и событий в целом используйте обработчик событий onEvent типа.
наследуется от ActivityHandler.onTokenResponseEvent
onTurn(BotHandler)
Регистрирует обработчик событий действия для события, создаваемого для каждого входящего действия независимо от типа.
function onTurn(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
наследуется от ActivityHandler.onTurn
onTyping(BotHandler)
Регистрирует обработчик событий действия для действия ввода действия.
function onTyping(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
Чтобы обработать событие typeing, используйте обработчик событий onTyping типа.
наследуется от ActivityHandler.onTyping
onUnrecognizedActivityType(BotHandler)
Регистрирует обработчик событий действия для нераспознанного типа действия события, создаваемого для входящего действия с типом, для которого ActivityHandler не предоставляет обработчик событий.
function onUnrecognizedActivityType(handler: BotHandler): this
Параметры
- handler
-
BotHandler
Обработчик событий.
Возвращаемое значение
this
Ссылка на объект ActivityHandler
Комментарии
ActivityHandler
не определяет события для всех типов действий, определенных в схеме действий Bot Framework. Кроме того, каналы и пользовательские адаптеры могут создавать действия с типами, не указанными в схеме. Когда обработчик действия получает такое событие, он выдает событие нераспознанного типа действия.
Свойство типа действия
наследуется от ActivityHandler.onUnrecognizedActivityType
run(TurnContext)
Вызывается для запуска процесса выбросов событий.
function run(context: TurnContext): Promise<void>
Параметры
- context
-
TurnContext
Объект контекста для текущего поворота.
Возвращаемое значение
Promise<void>
Комментарии
Как правило, этот метод предоставляется в качестве обработчика функций, вызываемого адаптером для выполнения логики бота после предварительной обработки полученного действия адаптером и перенаправленного через любое ПО промежуточного слоя.
Например:
server.post('/api/messages', (req, res) => {
adapter.processActivity(req, res, async (context) => {
// Route to bot's activity logic.
await bot.run(context);
});
});
См. также
наследуется от ActivityHandler.run