ActivityHandler Класс

Вызывается при отправке ботом действия адаптивной карточки.

Когда метод on_invoke_activity получает вызов с Activity.name adaptiveCard/action, вызывает этот метод.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

Параметры

Возвращаемое значение

Вызывается при получении действия обновления беседы из канала при использовании базового поведения on_turn.

async on_conversation_update_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_turn получает действие обновления беседы, он вызывает этот метод. Тоже

• Если действие обновления беседы указывает, что участники, отличные от бота, присоединились к беседе, он вызывает метод on_members_added_activity.
• Если действие обновления беседы указывает, что участники, отличные от бота, покинули беседу, он вызывает метод on_members_removed_activity.
• В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем действиям обновления беседы. Добавьте логику, применяемую перед добавлением или удалением логики элемента перед вызовом этого метода базового класса.

Вызывается при получении действия завершения беседы из канала.

async on_end_of_conversation_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Вызывается при получении события, отличного от маркеров и ответа при использовании базового поведения on_event_activity.

async on_event(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_event_activity получает событие с именем действия, кроме токенов и ответов, вызывает этот метод. Этот метод может быть переопределен, если бот предназначен для обработки других событий.

Вызывается при получении действия события из соединителя при использовании базового поведения on_turn.

async on_event_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_turn получает действие события, он вызывает этот метод. Если имя действия маркеров и ответов, вызывается on_token_response_event; в противном случае вызывается on_event.

В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем действиям события. Добавьте логику для применения до конкретной логики обработки событий перед вызовом этого метода базового класса. Добавьте логику для применения после конкретной логики обработки событий после вызова этого метода базового класса.

Действия событий передают программные сведения от клиента или канала боту. Значение действия события определяется свойством имени действия события, которое имеет смысл в пределах канала.

Переопределите это в производном классе, чтобы предоставить логику для действий ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

Параметры

Возвращаемое значение

Переопределите это в производном классе, чтобы предоставить логику, относясь к действиям ActivityTypes.InstallationUpdate, с помощью действия "action", заданного как "add".

async on_installation_update_add(turn_context: TurnContext)

Параметры

Возвращаемое значение

Переопределите это в производном классе, чтобы предоставить логику, относясь к действиям ActivityTypes.InstallationUpdate, с помощью действия action, заданного как remove.

async on_installation_update_remove(turn_context: TurnContext)

Параметры

Возвращаемое значение

Регистрирует обработчик событий действия для события вызова события, генерируемого для каждого входящего действия события.

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

Параметры

Возвращаемое значение

Переопределите этот метод в производном классе, чтобы обеспечить логику, если члены, отличные от бота, присоединяются к беседе. Вы можете добавить логику приветствия бота.

Действие обновления беседы :type members_added: List :p aram turn_context: объект контекста для этого поворота :type turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_conversation_update_activity получает действие обновления беседы, указывающее, что один или несколько пользователей, отличных от бота, присоединяются к беседе, он вызывает этот метод.

Переопределите этот метод в производном классе, чтобы обеспечить логику, если члены, отличные от бота, покидают беседу. Вы можете добавить логику хорошего бота.

Действие обновления беседы :type members_added: List :p aram turn_context: объект контекста для этого поворота :type turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_conversation_update_activity получает действие обновления беседы, указывающее, что один или несколько пользователей, отличных от бота, покидают беседу, вызывает этот метод.

Переопределите этот метод в производном классе, чтобы обеспечить логику для действий, таких как логика беседы.

async on_message_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Вызывается при получении действия события из соединителя при использовании базового поведения on_turn.

async on_message_reaction_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Реакции сообщений соответствуют пользователю, добавляя "как" или "грустный" и т. д. (часто эмодзи) в ранее отправленное действие.

Реакции на сообщения поддерживаются только несколькими каналами. Действие, которое соответствует реакции сообщения, указывается в свойстве "Идентификатор". Значение этого свойства — это идентификатор действия ранее отправленного действия, возвращаемого боту в качестве ответа от вызова отправки. Когда метод on_turn получает действие реакции сообщения, он вызывает этот метод.

• Если реакция сообщения указывает на то, что реакции были добавлены в сообщение, он вызывает

<xref:botbuilder.core.ActivityHandler.on_reaction_added>.

• Если реакция сообщения указывает на то, что реакции были удалены из сообщения, он вызывает <xref:botbuilder.core.ActivityHandler.on_reaction_removed>.

В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем действиям реакции сообщения. Добавьте логику, применяемую перед добавлением или удалением логики перед вызовом этого метода базового класса. Добавьте логику для применения после добавления или удаления логики после вызова метода базового класса.

Переопределите этот метод в производном классе, чтобы обеспечить логику при добавлении реакций на предыдущее действие в беседу.

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Реакции на сообщения соответствуют пользователю, добавляя "нравится" или "грустный" и т. д. (часто эмодзи) в ранее отправленное сообщение в беседе. Реакции на сообщения поддерживаются только несколькими каналами. Действие, на которое сообщение реагирует, определяется ответом действия на свойство ID. Значение этого свойства — это идентификатор действия ранее отправленного действия. Когда бот отправляет действие, канал назначает ему идентификатор, который доступен в идентификаторе ответа ресурса результата.

Переопределите этот метод в производном классе, чтобы обеспечить логику при удалении реакций на предыдущее действие из беседы.

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Реакции на сообщения соответствуют пользователю, добавляя "нравится" или "грустный" и т. д. (часто эмодзи) в ранее отправленное сообщение в беседе. Реакции на сообщения поддерживаются только несколькими каналами. Действие, на которое сообщение реагирует, определяется ответом действия на свойство Id. Значение этого свойства — это идентификатор действия ранее отправленного действия. Когда бот отправляет действие, канал назначает ему идентификатор, который доступен в идентификаторе ответа ресурса результата.

Вызывается при получении события signin/verifyState или signin/tokenExchange, когда используется базовое поведение on_invoke_activity(TurnContext{InvokeActivity}). При использовании OAuthPrompt переопределите этот метод для пересылки этого действия"/ в текущее диалоговое окно. По умолчанию этот метод ничего не делает.

async on_sign_in_invoke(turn_context: TurnContext)

Параметры

Возвращаемое значение

Вызывается при получении события маркеров и ответа при использовании базового поведения on_event_activity. При использовании oauth_promptпереопределите этот метод, чтобы перенаправлять это действие в текущее диалоговое окно.

async on_token_response_event(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_event получает событие с именем действия токенов и ответов, он вызывает этот метод. Если бот использует oauth_prompt, перенаправьте входящие действия в текущее диалоговое окно.

Вызывается адаптером (например, BotFrameworkAdapter) во время выполнения для обработки входящего Activity.

async on_turn(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Он вызывает другие методы в этом классе на основе типа действия для обработки, что позволяет производному классу предоставлять логику, определяемую типом, управляемым способом. В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем типам действий. Тоже

• Добавьте логику, применяемую перед логикой для конкретного типа и перед вызовом on_turn.
• Добавьте логику для применения после логики для конкретного типа после вызова on_turn.

Переопределите это в производном классе, чтобы обеспечить логику, относяющуюся к действиям ActivityTypes.typeing, например логике беседы.

async on_typing_activity(turn_context: TurnContext)

Параметры

Возвращаемое значение

Вызывается при получении действия, отличного от сообщения, обновления беседы или события при использовании базового поведения on_turn. При переопределении этот метод может потенциально реагировать на любой из других типов действий.

async on_unrecognized_activity_type(turn_context: TurnContext)

Параметры

Возвращаемое значение

Комментарии

Когда метод on_turn получает действие, которое не является сообщением, обновлением беседы, реакцией сообщения или действием события, он вызывает этот метод.