ActivityHandler Класс

Обрабатывает действия и должен быть подклассом.

Наследование

Bot

ActivityHandler

Конструктор

ActivityHandler()

Комментарии

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

Методы

on_adaptive_card_invoke	Вызывается при отправке боту действия адаптивной карточки Execute. Когда метод on_invoke_activity получает вызов с Activity.name adaptiveCard/action, он вызывает этот метод.
on_conversation_update_activity	Вызывается при получении действия обновления диалога из канала при использовании базового поведения on_turn .
on_end_of_conversation_activity	Вызывается при получении действия завершения диалога из канала.
on_event	Вызывается при получении события, отличного от токенов или ответа , при использовании базового поведения on_event_activity .
on_event_activity	Вызывается при получении действия события от соединителя при использовании базового поведения on_turn .
on_installation_update	Переопределите его в производном классе, чтобы предоставить логику действий ActivityTypes.InstallationUpdate.
on_installation_update_add	Переопределите это значение в производном классе, чтобы предоставить логику, специфичную для действий ActivityTypes.InstallationUpdate, указав для параметра action значение add.
on_installation_update_remove	Переопределите его в производном классе, чтобы предоставить логику действий ActivityTypes.InstallationUpdate, указав для параметра action значение remove.
on_invoke_activity	Регистрирует обработчик событий действия для события вызова , выдаваемого для каждого входящего действия события.
on_members_added_activity	Переопределите этот метод в производном классе, чтобы обеспечить логику, когда члены, отличные от бота, присоединяются к диалогу. Вы можете добавить логику приветствия бота. conversation update activity :type members_added: List :p aram turn_context: объект контекста для этого шага :type turn_context: TurnContext
on_members_removed_activity	Переопределите этот метод в производном классе, чтобы предоставить логику, когда члены, отличные от бота, покидают беседу. Вы можете добавить логику "прощай" бота. conversation update activity :type members_added: List :p aram turn_context: объект контекста для этого шага :type turn_context: TurnContext
on_message_activity	Переопределите этот метод в производном классе, чтобы предоставить логику для конкретных действий, таких как логика диалога.
on_message_reaction_activity	Вызывается при получении действия события от соединителя при использовании базового поведения on_turn .
on_reactions_added	Переопределите этот метод в производном классе, чтобы обеспечить логику при добавлении реакций на предыдущее действие в диалог.
on_reactions_removed	Переопределите этот метод в производном классе, чтобы обеспечить логику при удалении реакций на предыдущее действие из диалога.
on_sign_in_invoke	Вызывается при получении события signin/verifyState или signin/tokenExchange при использовании базового поведения on_invoke_activity(TurnContext{InvokeActivity}). Если используется OAuthPrompt, переопределите этот метод, чтобы перенаправлять это действие в текущее диалоговое окно. По умолчанию этот метод не выполняет никаких действий.
on_token_response_event	Вызывается при получении события токенов или ответа при использовании базового поведения on_event_activity . При использовании oauth_prompt переопределите этот метод, чтобы перенаправить это действие в текущий диалог.
on_turn	Вызывается адаптером (например, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) во время выполнения для обработки входящего Activity.
on_typing_activity	Переопределите его в производном классе, чтобы предоставить логику, относяющуюся к действиям ActivityTypes.typeing, например логике беседы.
on_unrecognized_activity_type	Вызывается при получении действия, отличного от сообщения, обновления беседы или события при использовании базового поведения on_turn . При переопределении этот метод может потенциально реагировать на любые другие типы действий.

on_adaptive_card_invoke

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

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

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

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага.
invoke_value Обязательно	<xref:botframework.schema.models.AdaptiveCardInvokeValue> Объект строкового типа из значения входящего действия.

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

Тип	Описание
	Объект HealthCheckResponse

on_conversation_update_activity

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

async on_conversation_update_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

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

on_end_of_conversation_activity

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

async on_end_of_conversation_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_event

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

async on_event(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_event_activity

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

async on_event_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

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

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

on_installation_update

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

async on_installation_update(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_installation_update_add

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

async on_installation_update_add(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_installation_update_remove

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

async on_installation_update_remove(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_invoke_activity

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

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

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_members_added_activity

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

conversation update activity :type members_added: List :p aram turn_context: объект контекста для этого шага :type turn_context: TurnContext

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

Параметры

Имя	Описание
members_added Обязательно
turn_context Обязательно

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_members_removed_activity

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

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)

Параметры

Имя	Описание
members_removed Обязательно
turn_context Обязательно

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_message_activity

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

async on_message_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_message_reaction_activity

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

async on_message_reaction_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

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

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

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

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

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

on_reactions_added

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

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

Параметры

Имя	Описание
message_reactions Обязательно	List Добавлен список реакций
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_reactions_removed

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

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

Параметры

Имя	Описание
message_reactions Обязательно	List Список реакций удален
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_sign_in_invoke

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

async on_sign_in_invoke(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

on_token_response_event

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

async on_token_response_event(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения

Комментарии

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

on_turn

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

async on_turn(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения.

Комментарии

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

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

on_typing_activity

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

async on_typing_activity(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения.

on_unrecognized_activity_type

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

async on_unrecognized_activity_type(turn_context: TurnContext)

Параметры

Имя	Описание
turn_context Обязательно	TurnContext Объект контекста для этого шага

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

Тип	Описание
	Задача, представляющая работу, поставленную в очередь для выполнения.

Комментарии

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